Skip to content

Commit

Permalink
Add hint about debug profile
Browse files Browse the repository at this point in the history
  • Loading branch information
fa2k committed Oct 16, 2023
1 parent 4d3b3d4 commit 7a39194
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/content/docs/contributing/adding_pipelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,9 @@ to make sure that your workflow passes all of the nf-core compatibility tests.
The automated tests on Github Actions also run this, so you should get a
notification from GitHub if something breaks.

When testing the pipeline you can add the `debug` profile (`-profile debug`) to the Nextflow command line,
to enable warnings about process selectors, show additional debug output and disable cleanup.

## Running with test data

Whilst the linting tests are good, they're not sufficient by themselves.
Expand Down
3 changes: 3 additions & 0 deletions src/content/docs/contributing/contributing_to_pipelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@ If you're new to working with git, you can view the [GitHub pull requests docume

## Testing

You can optionally test your changes by running the pipeline locally. Then it is recommended to use the `debug` profile to
receive warnings about process selectors and other debug info. Example: `nextflow run . -profile debug,test,docker --outdir <OUTDIR>`.

When you create a pull request with changes, [GitHub Actions](https://github.com/features/actions) will run automatic tests.
Typically, pull-requests are only fully reviewed when these tests are passing, though of course, we can help out before then.

Expand Down

0 comments on commit 7a39194

Please sign in to comment.