modules
modules copied to clipboard
Migrate all modules to nf-test (batch 2)
Modules nf-test migration
(This is the second batch - batch 1 is here)
Some documentation available for this project:
- Slack channel
- Migration doc
- nf-test guidelines
- bytesize talk on nf-test
- bytesize talk on nf-test migration
- pytest2nf-test automatic migration tool
Workflow
- Create a conda
environment.ymlfile with nf-core, nextflow, nf-test, prettier and pre-commit and activate it. - Run
pre-commit install - Fork https://github.com/nf-core/modules
- Clone the fork locally
git clone [email protected]:githubusername/modules.git - Clone also locally pytest2nf-test
git clone https://github.com/GallVp/pytest2nf-test- Install it
cd pytest2nf-test+./gradlew installDist - Add build to path or add alias
alias pytest2nf-test=${PWD}/build/install/pytest2nf-test/bin/pytest2nf-test
- Install it
- Select the module you want to work on and assign yourself to the sub-issue below.
- Update your local branch to match the nf-core repository
git checkout mainandgit pull upstream main - Work on a branch
git checkout -b <modules_name>_nftest - Run
pytest2nf-test --nf-core-module <tool>/<subtool> - Check the migration and modify it accordingly
- Run
nf-core modules test <tool>/<subtool> - Lint the code
nf-core modules lint <tool>/<subtool> - Commit the changes
git add .andgit commit -m "<commit_message>" - Push to your github repository
git push origin <modules_name>_nftest - Open a Pull-Request and link it to the sub-issue by adding
#75XXto the details - Check that github action run correctly
- Fix if necessary
- Ask for review and add the nf-test tag to the PR
- Rinse and repeat 6 - 17