Skip to content

Bump bcftools modules#338

Merged
matthdsm merged 10 commits into
devfrom
bump/bcftools
Jun 4, 2026
Merged

Bump bcftools modules#338
matthdsm merged 10 commits into
devfrom
bump/bcftools

Conversation

@matthdsm

@matthdsm matthdsm commented Jun 4, 2026

Copy link
Copy Markdown
Member

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
  • 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).

@matthdsm matthdsm linked an issue Jun 4, 2026 that may be closed by this pull request
@matthdsm matthdsm changed the base branch from main to dev June 4, 2026 08:34

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the pipeline to use the latest nf-core bcftools module revisions, primarily standardizing VCF index outputs from separate tbi/csi channels into a single index channel and updating downstream wiring + tests accordingly. This aligns the workflow and subworkflows with the updated module interfaces and refreshes module metadata, environments, and snapshots.

Changes:

  • Updated multiple workflows/subworkflows to join on *.out.index instead of *.out.tbi.
  • Updated nf-core bcftools module definitions (main.nf, meta.yml, environment.yml) to emit a unified index output and refreshed associated nf-test snapshots/tests.
  • Bumped modules.json module SHAs and added a CHANGELOG.md entry for the patch release.

Reviewed changes

Copilot reviewed 55 out of 55 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
workflows/smallvariants.nf Updates BCFTOOLS_NORM output join to use out.index.
subworkflows/local/vcf_upd_updio/main.nf Updates BCFTOOLS_VIEW output join to use out.index.
subworkflows/local/vcf_ped_rtgtools/main.nf Updates BCFTOOLS_ANNOTATE output join to use out.index.
subworkflows/local/vcf_filter_bcftools/main.nf Updates BCFTOOLS_FILTER output join to use out.index (but currently mismatched with the included local module output; see comments).
subworkflows/local/vcf_concat_bcftools/main.nf Updates BCFTOOLS_CONCAT output join to use out.index.
subworkflows/local/vcf_annotate_ensemblvep/main.nf Updates BCFTOOLS_SORT output join to use out.index after concatenation.
modules/nf-core/bcftools/view/main.nf Collapses tbi/csi outputs into a single optional index output.
modules/nf-core/bcftools/view/meta.yml Updates outputs to index and reformats metadata fields.
modules/nf-core/bcftools/view/environment.yml Adds renovate hint for bcftools and retains htslib pin.
modules/nf-core/bcftools/view/tests/main.nf.test Updates nf-test assertions to use process.out.index.
modules/nf-core/bcftools/view/tests/main.nf.test.snap Updates stored snapshots to reflect index output structure.
modules/nf-core/bcftools/sort/main.nf Collapses tbi/csi outputs into a single optional index output.
modules/nf-core/bcftools/sort/meta.yml Updates outputs to index and reformats metadata fields.
modules/nf-core/bcftools/sort/environment.yml Adds renovate hint for bcftools and retains htslib pin.
modules/nf-core/bcftools/sort/tests/main.nf.test Updates nf-test assertions to use process.out.index.
modules/nf-core/bcftools/sort/tests/main.nf.test.snap Updates stored snapshots to reflect index output structure.
modules/nf-core/bcftools/norm/main.nf Collapses tbi/csi outputs into a single optional index output.
modules/nf-core/bcftools/norm/meta.yml Updates outputs to index and reformats metadata fields.
modules/nf-core/bcftools/norm/environment.yml Adds renovate hint for bcftools and retains htslib pin.
modules/nf-core/bcftools/norm/tests/main.nf.test Updates nf-test assertions to use process.out.index.
modules/nf-core/bcftools/norm/tests/main.nf.test.snap Updates stored snapshots to reflect index output structure.
modules/nf-core/bcftools/filter/main.nf Collapses tbi/csi outputs into a single optional index output.
modules/nf-core/bcftools/filter/meta.yml Updates outputs to index and reformats metadata fields.
modules/nf-core/bcftools/filter/environment.yml Adds renovate hint for bcftools and retains htslib pin.
modules/nf-core/bcftools/filter/tests/main.nf.test Updates nf-test assertions to use process.out.index.
modules/nf-core/bcftools/filter/tests/main.nf.test.snap Updates stored snapshots to reflect index output structure.
modules/nf-core/bcftools/concat/main.nf Collapses tbi/csi outputs into a single optional index output.
modules/nf-core/bcftools/concat/meta.yml Updates outputs to index and reformats metadata fields.
modules/nf-core/bcftools/concat/environment.yml Adds renovate hint for bcftools and retains htslib pin.
modules/nf-core/bcftools/concat/tests/main.nf.test Updates nf-test assertions to use process.out.index.
modules/nf-core/bcftools/concat/tests/main.nf.test.snap Updates stored snapshots to reflect index output structure.
modules/nf-core/bcftools/annotate/main.nf Collapses tbi/csi outputs into a single optional index output.
modules/nf-core/bcftools/annotate/meta.yml Updates outputs to index and reformats metadata fields.
modules/nf-core/bcftools/annotate/environment.yml Adds renovate hint for bcftools and retains htslib pin.
modules/nf-core/bcftools/annotate/tests/main.nf.test Updates nf-test assertions to use process.out.index.
modules/nf-core/bcftools/annotate/tests/main.nf.test.snap Updates stored snapshots to reflect index output structure.
modules/nf-core/bcftools/pluginscatter/main.nf Collapses tbi/csi outputs into a single optional index output.
modules/nf-core/bcftools/pluginscatter/meta.yml Updates outputs to index and reformats metadata fields.
modules/nf-core/bcftools/pluginscatter/environment.yml Adds renovate hint for bcftools and retains htslib pin.
modules/nf-core/bcftools/pluginscatter/tests/main.nf.test Updates nf-test assertions to use process.out.index.
modules/nf-core/bcftools/pluginscatter/tests/main.nf.test.snap Updates stored snapshots to reflect index output structure.
modules/nf-core/bcftools/query/meta.yml Reformats metadata fields (licence and version command typing).
modules/nf-core/bcftools/query/environment.yml Adds renovate hint for bcftools and retains htslib pin.
modules/nf-core/bcftools/reheader/meta.yml Reformats metadata fields (licence and version command typing).
modules/nf-core/bcftools/reheader/environment.yml Adds renovate hint for bcftools and retains htslib pin.
modules/nf-core/bcftools/stats/meta.yml Reformats metadata fields (licence and version command typing).
modules/nf-core/bcftools/stats/environment.yml Adds renovate hint for bcftools and retains htslib pin.
modules.json Updates pinned nf-core module SHAs for the bcftools module set.
CHANGELOG.md Adds v1.13.3 entry documenting the bcftools module bump.
Comments suppressed due to low confidence (3)

subworkflows/local/vcf_concat_bcftools/main.nf:32

  • The emitted channel comment still documents the third tuple element as path(tbi), but this workflow now joins BCFTOOLS_CONCAT.out.index (which may be .tbi or .csi).
    subworkflows/local/vcf_ped_rtgtools/main.nf:42
  • The emitted tuple comment still says path(tbi), but the workflow now joins on BCFTOOLS_ANNOTATE.out.index (which can be .tbi or .csi).
    subworkflows/local/vcf_annotate_ensemblvep/main.nf:137
  • This emitted channel comment still describes the output as [ val(meta), path(vcf), path(tbi) ], but the join is now performed against BCFTOOLS_SORT.out.index (which may be .tbi or .csi).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines 216 to 220
process.out.vcf,
process.out.csi.collect { it.collect { it instanceof Map ? it : file(it).name } },
process.out.tbi.collect { it.collect { it instanceof Map ? it : file(it).name } },
process.out.index.collect { it.collect { it instanceof Map ? it : file(it).name } },
process.out.index.collect { it.collect { it instanceof Map ? it : file(it).name } },
process.out.findAll { key, val -> key.startsWith("versions") }
).match() }
Comment on lines 342 to 346
process.out.vcf.collect { it.collect { it instanceof Map ? it : file(it).name }},
process.out.tbi.collect { it.collect { it instanceof Map ? it : file(it).name }},
process.out.csi.collect { it.collect { it instanceof Map ? it : file(it).name }},
process.out.index.collect { it.collect { it instanceof Map ? it : file(it).name }},
process.out.index.collect { it.collect { it instanceof Map ? it : file(it).name }},
process.out.findAll { key, val -> key.startsWith("versions") }
).match() }
Comment on lines 377 to 381
process.out.vcf.collect { it.collect { it instanceof Map ? it : file(it).name }},
process.out.tbi.collect { it.collect { it instanceof Map ? it : file(it).name }},
process.out.csi.collect { it.collect { it instanceof Map ? it : file(it).name }},
process.out.index.collect { it.collect { it instanceof Map ? it : file(it).name }},
process.out.index.collect { it.collect { it instanceof Map ? it : file(it).name }},
process.out.findAll { key, val -> key.startsWith("versions") }
).match() }
@@ -63,37 +64,25 @@ output:
description: VCF normalized output file
Comment thread subworkflows/local/vcf_filter_bcftools/main.nf

@jhaezebr jhaezebr left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I have no idea what I'm doing

@matthdsm matthdsm merged commit 6a30339 into dev Jun 4, 2026
49 of 53 checks passed
@matthdsm matthdsm deleted the bump/bcftools branch June 4, 2026 11:38
matthdsm added a commit that referenced this pull request Jun 6, 2026
* Bump bcftools modules (#338)
* downgrade mosdepth (#336)
* bump pipeline version (#339)
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.

bcftools_concat fails consistently when running on nomad

3 participants