-
Notifications
You must be signed in to change notification settings - Fork 196
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
Improved nf test scope docs to describe how portable nf-core/modules 'tests' should be #2876
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for nf-core-main-site ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for nf-core-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
@christopher-hakkaart as always language clean up would be grand if you have a moment <3 |
|
||
Tests for modules SHOULD be be designed to be able to execute within the nf-core/modules GitHub repository CI with example test data. | ||
|
||
Tests for modules MUST at a minimum run on the GitHub repository CI with a stub test that replicates the generation of (empty) output files. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
and version snapshot
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
sites/docs/src/content/docs/guidelines/components/subworkflows.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Júlia Mir Pedrol <[email protected]>
In that discussion, there was a quite neat proposal: Using dedicated tags to distinguish the two: In that case, Otherwise, tests from the modules' repo would need to be manually deleted in the pipeline repositories after every run of |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No major objections.
Comments are suggestions that I think help improve clarity but feel free to disagree.
sites/docs/src/content/docs/guidelines/components/subworkflows.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/guidelines/components/subworkflows.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/guidelines/components/subworkflows.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/guidelines/components/subworkflows.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/guidelines/components/subworkflows.md
Outdated
Show resolved
Hide resolved
You can use |
Co-authored-by: Christopher Hakkaart <[email protected]>
As discussed here: https://nfcore.slack.com/archives/C049MBCEW06/p1731521149600189
@netlify /docs/guidelines/components/modules