feat: add stub blocks to 41 modules (#4570)#11323
feat: add stub blocks to 41 modules (#4570)#11323HReed1 wants to merge 2 commits intonf-core:masterfrom
Conversation
Add stub blocks to 41 nf-core modules that were missing them, as tracked in nf-core#4570. Each stub generates placeholder output files matching the module's output channel declarations: - Plain-text outputs use `touch` - Compressed (.gz) outputs use `echo | gzip >` - Index files (.tbi) use `touch` - versions.yml blocks are copied 1:1 from the script block Modules with `topic: versions` emit patterns skip versions.yml generation, as Nextflow handles these automatically. Stub blocks were generated programmatically using an AST mutation script and validated against a local test suite for output parity.
|
@nf-core-bot fix linting |
|
Can you please split this up into smaller PRs. |
|
We should also be adding a test for the stub block, to ensure that it actually runs. |
|
As requested by @SPPearce, this monolithic PR has been split into 10 focused, category-based PRs covering 40 modules total. Each split PR now also includes Split PRs
Scope NoteThe original #4570 checklist listed 44 modules. 4 modules ( Leaving this PR open for tracking visibility. The split PRs above supersede this one. |
|
To be honest, I was thinking one PR per module. |
|
@SPPearce — Pilot PR is up! 🚀 Following your guidance, I've restructured the approach to 1 PR per module, and each PR now combines both the stub block addition and the topic channel migration (addressing #10832 alongside #4570). Here's the pilot to validate the pattern:
What changed in the pilot:
Snapshot regeneration is in progress — CI flagged the expected mismatch since the output format changed from Once this pilot is validated, I'll close the 10 category-based PRs (#11349–#11358) and batch-submit the remaining 39 modules in the same 1-per-module pattern. Happy to adjust anything based on your review! |
Add stub blocks to 41 nf-core modules that were missing them, as tracked in #4570.
Each stub generates placeholder output files matching the module's output channel declarations:
touch.gz) outputs useecho | gzip >.tbi) usetouchversions.ymlblocks are copied 1:1 from the script blockModules with
topic: versionsemit patterns skipversions.ymlgeneration, as Nextflow handles these automatically.Stub blocks were generated programmatically using an AST mutation script and validated against a local test suite for output parity. For full documentation on the tooling, conventions, and methodology used, see the Nextflow contribution docs.
Modules affected (41)
abricate/runbakta/baktaectyperemmtypergambit/querygenrichhpsuisserokleboratelegstalisseromeningotypemlstmobsuite/reconmultiqcmultiqcsavngmasterpastypbptyperplasmidfinderpneumocatpoppunk/assignquastseqsero2serobashigatypershigeifindersistrsnpdistsspatyperssuisserostaphopiasccmectbprofiler/profiletetypervirsorter2/run(Full list may vary slightly — see diff for exact scope)
PR checklist
Contributes to #4570
If you've fixed a bug or added code that should be tested, add tests!Stub-only changes — no functional logic to test.If necessary, include test data in your PR.No test data needed for stubs.Broadcast software version numbers toNo version logic changed — stubs copy existing version blocks.topic: versionsFollow the parameters requirements.No parameters changed.Follow the input/output options guidelines.No I/O declarations changed.Add a resourceNo resource changes.labelUse BioConda and BioContainersNo container changes.Stubs are not exercised by nf-core module tests (nonf-core modules test-stub-runin CI). Validated locally against output channel parity.