Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate all modules to nf-test (batch 2) #7654

Open
LouisLeNezet opened this issue Feb 28, 2025 · 0 comments
Open

Migrate all modules to nf-test (batch 2) #7654

LouisLeNezet opened this issue Feb 28, 2025 · 0 comments

Comments

@LouisLeNezet
Copy link
Contributor

LouisLeNezet commented Feb 28, 2025

Modules nf-test migration

(This is the second batch - batch 1 is here)

Some documentation available for this project:

Workflow

  1. Create a conda environment.yml file with nf-core, nextflow, nf-test, prettier and pre-commit and activate it.
  2. Run pre-commit install
  3. Fork https://github.com/nf-core/modules
  4. Clone the fork locally git clone git@github.com:githubusername/modules.git
  5. 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
  6. Select the module you want to work on and assign yourself to the sub-issue below. Image
  7. Update your local branch to match the nf-core repository git checkout main and git pull upstream main
  8. Work on a branch git checkout -b <modules_name>_nftest
  9. Run pytest2nf-test --nf-core-module <tool>/<subtool>
  10. Check the migration and modify it accordingly
  11. Run nf-core modules test <tool>/<subtool>
  12. Lint the code nf-core modules lint <tool>/<subtool>
  13. Commit the changes git add . and git commit -m "<commit_message>"
  14. Push to your github repository git push origin <modules_name>_nftest
  15. Open a Pull-Request and link it to the sub-issue by adding #75XX to the details
    Image
  16. Check that github action run correctly
  17. Fix if necessary
  18. Ask for review and add the nf-test tag to the PR
    Image
  19. Rinse and repeat 6 - 17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In Progress
Status: To do
Status: Todo
Development

No branches or pull requests

1 participant