Skip to content

Release 2.2.1#140

Open
famosab wants to merge 20 commits intomasterfrom
dev
Open

Release 2.2.1#140
famosab wants to merge 20 commits intomasterfrom
dev

Conversation

@famosab
Copy link
Copy Markdown
Contributor

@famosab famosab commented May 4, 2026

PR checklist

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the pipeline conventions in the contribution docs
  • If necessary, also make a PR on the nf-core/bamtofastq branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core pipelines lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • Usage Documentation in docs/usage.md is updated.
  • Output Documentation in docs/output.md is updated.
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

Only missing the version bump - debating between 2.3.0 and 2.2.1!

nf-core-bot and others added 18 commits June 3, 2025 11:01
Synchronize dev and master branch
* Back to dev 2.3.0dev

* Prettier
Important! Template update for nf-core/tools v3.3.2
* Template update for nf-core/tools version 3.4.1

* Apply suggestion from @famosab

* Update snaps

* rocrate

* snap

* Apply suggestion from @famosab

* Apply suggestion from @famosab

* unify the tests

---------

Co-authored-by: Famke Bäuerle <45968370+famosab@users.noreply.github.com>
Co-authored-by: Famke Bäuerle <famke.baeuerle@gmail.com>
Important! Template update for nf-core/tools v3.5.1
* fix: nf lint to adhere to strict syntax

* update all modules and remove versions statements if needed

* update sbwf

* Changelog and gzi input channel

* pre-commit

* update local module

* update first snap

* update snaps

* bump nextflow to 25.10.2

* rocrate

* Changelog

* udpate last modules

* udpate last modules

* correct snaps

* bump nf-schema
* Recover help message

* Changelog
* Template update for nf-core/tools version 4.0.0

* Template update for nf-core/tools version 4.0.2

* fix: monochrome logs

* recover multiqc title and changelog

* Changelog

---------

Co-authored-by: Famke Bäuerle <45968370+famosab@users.noreply.github.com>
Co-authored-by: Famke Bäuerle <famke.baeuerle@gmail.com>
…/subworkflows}/nf-core/**/tests/` (#139)

* Update all modules

* remove module tests

* remove sbwf tests

* gitignore

* Update snaps

* correct unmap

* update modules

* synchronize paths

* update collate

* queue and value

* update snaps

* update default snap

* update changelog

* update changelog

* prek

* changelog

* Solve queue issue

* Update nextflow_schema.json

Co-authored-by: Maxime U Garcia <max.u.garcia@gmail.com>

* Update nextflow.config

Co-authored-by: Maxime U Garcia <max.u.garcia@gmail.com>

---------

Co-authored-by: Maxime U Garcia <max.u.garcia@gmail.com>
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 4, 2026

nf-core pipelines lint overall result: Failed ❌

Posted for pipeline commit 891ca2b

+| ✅ 246 tests passed       |+
!| ❗   5 tests had warnings |!
-| ❌   3 tests failed       |-
Details

❌ Test failures:

❗ Test warnings:

  • pipeline_todos - TODO string in awsfulltest.yml: You can customise AWS full pipeline tests as required
  • pipeline_todos - TODO string in main.nf: Optionally add in-text citation tools to this list.
  • pipeline_todos - TODO string in main.nf: Optionally add bibliographic entries to this list.
  • pipeline_todos - TODO string in main.nf: Only uncomment below if logic in toolCitationText/toolBibliographyText has been filled!
  • pipeline_if_empty_null - ifEmpty(null) found in /home/runner/work/bamtofastq/bamtofastq/lint_results.md: _* pipeline_if_empty_null - No ifEmpty(null) strings found
    _

✅ Tests passed:

Run details

  • nf-core/tools version 4.0.2
  • Run at 2026-05-07 10:53:10

famosab added 2 commits May 6, 2026 14:18
* Update local sbwf and module to adhere to directory structure

* Update snaps

* Add meta maps

* Add test for local module
* Add tests to local subworkflows

* Changelog

* try rescuing the value channel

* more collect

* finalize

* avoid overwritng

* update snap

* Update default test

* Apply suggestion from @famosab

* simplify test
Copy link
Copy Markdown
Member

@pinin4fjords pinin4fjords left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AI-assisted review (Claude, on behalf of @pinin4fjords). Posted as comments only - no approve/request-changes.

Reviewed against 891ca2b on the dev branch. The vast majority of the diff is template merges (3.3.1 → 4.0.2) and nf-core modules update output, which I skimmed but did not line-by-line review. Comments below focus on the substantive functional changes (local module rename, fai-handling refactor in #142, local subworkflow restructuring).

The 🔴 high-severity item, the medium .collect()/meta.yaml-content notes, and the low-severity import-cleanup are inline. The body covers only what isn't already on a specific line.

Cross-cutting items not covered inline

  • 🟠 Medium — meta.yamlmeta.yml rename across all local components. nf-core pipelines lint (4.0.2) flags meta_yml_exists warnings on every local subworkflow because they ship meta.yaml instead of meta.yml — four subworkflows (alignment_to_fastq, pre_conversion_qc, prepare_indices, utils_nfcore_bamtofastq_pipeline) plus the local module checkpairedend. Pure rename to fix.
  • 🟠 Medium — template logo drift. Lint reports files_unchanged: docs/images/nf-core-bamtofastq_logo_dark.png does not match the template. Auto-fixable with nf-core pipelines lint --dir . --fix files_unchanged.

Upstream-candidacy of the new local components

Since this PR is reshaping the local subworkflows, worth flagging which of the four pieces look like they should live in nf-core/modules or nf-core/subworkflows rather than here:

  • alignment_to_fastq — the same 4-way SAMTOOLS_VIEW_{MAP,UNMAP}_{MAP,UNMAP} + SAMTOOLS_MERGE + SAMTOOLS_COLLATEFASTQ + CAT_FASTQ pattern lives in nf-core/sarek/subworkflows/local/bam_convert_samtools/main.nf. The pattern is duplicated across two pipelines today — strong candidate for promotion to nf-core/subworkflows so both can share, especially since both have to keep the four withName: SAMTOOLS_VIEW_{MAP_MAP,UNMAP_UNMAP,...} flag-filter strings in sync via modules.config.
  • pre_conversion_qc — the stats/flagstat/idxstats trio is already nf-core/subworkflows/bam_stats_samtools upstream. The local sbwf could either reuse that and add the FASTQC branch on top, or upstream a new bam_stats_samtools_fastqc variant.
  • checkpairedend — generic samtools-only paired-end detection, no equivalent in nf-core/modules. Useful to anyone consuming user-supplied BAM/CRAM. Good promotion candidate.
  • prepare_indices — essentially a 2-process wrapper around SAMTOOLS_INDEX + SAMTOOLS_FAIDX with index-detection branching. Marginal upstream value; could be promoted, or left local since most of the logic is the index-flag branching which is pipeline-shaped.

Bundled cleanups (informational)

Nothing release-blocking, grouped here so a single follow-up can clear them:

  • The version in nextflow.config:312 is 2.3.0dev but PR title is Release 2.2.1 — confirmed offline with the author that the dev suffix is a leftover from version-bumping; should be 2.2.1 (and .nf-core.yml/CHANGELOG.md heading updated to match).
  • Pre-existing but worth noting next time assets/schema_input.json is touched: line 34 uses "enums" (plural) where JSON Schema is "enum". Silently ignored by nf-schema, so the runtime meta.filetype != mapped.getExtension() check in utils_nfcore_bamtofastq_pipeline/main.nf:111 is doing all the validation work.
  • subworkflow_version: New version available for subworkflows/nf-core/utils_nextflow_pipeline and utils_nfschema_plugin.
  • pipeline_todos: toolCitationText / toolBibliographyText TODO stubs in subworkflows/local/utils_nfcore_bamtofastq_pipeline/main.nf and a TODO in .github/workflows/awsfulltest.yml. Either fill them in or strip the markers.

Comment thread workflows/bamtofastq.nf
Comment thread workflows/bamtofastq.nf
Comment thread subworkflows/local/prepare_indices/meta.yaml
Comment thread subworkflows/local/utils_nfcore_bamtofastq_pipeline/main.nf
Comment thread modules/local/checkpairedend/meta.yaml
Comment thread modules/local/checkpairedend/meta.yaml
Copy link
Copy Markdown
Member

@pinin4fjords pinin4fjords left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Giving you my approval to unblock, I'm sure you will resolve the issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants