Skip to content

Template update to version 3.5.1#118

Merged
robert-a-forsyth merged 36 commits into
devfrom
template_351
Jan 8, 2026
Merged

Template update to version 3.5.1#118
robert-a-forsyth merged 36 commits into
devfrom
template_351

Conversation

@ljwharbers
Copy link
Copy Markdown
Collaborator

@ljwharbers ljwharbers commented Dec 24, 2025

Template update to version 3.5.1
Including major updates to versioning output of all modules (where possible) to topics.

PR also includes updates to meta.yml files to complete the descriptions of tools/input/outputs where it was still missing.

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

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Dec 24, 2025

nf-core pipelines lint overall result: Passed ✅ ⚠️

Posted for pipeline commit fc3c847

+| ✅ 178 tests passed       |+
#| ❔  21 tests were ignored |#
#| ❔   1 tests had warnings |#
!| ❗  28 tests had warnings |!
Details

❗ Test warnings:

  • pipeline_todos - TODO string in nextflow.config: Specify your pipeline's command line flags
  • pipeline_todos - TODO string in nextflow.config: Update the field with the details of the contributors to your pipeline. New with Nextflow version 24.10.0
  • pipeline_todos - TODO string in lint_log.txt: Named file extensions MUST be emitted for ALL output channels
  • pipeline_todos - TODO string in lint_log.txt: List additional required output channels/values here
  • pipeline_todos - TODO string in lint_log.txt: Named file extensions MUST be emitted for ALL output channels
  • pipeline_todos - TODO string in lint_log.txt: List additional required output channels/values here
  • pipeline_todos - TODO string in lint_log.txt: Named file extensions MUST be emitted for ALL output channels
  • pipeline_todos - TODO string in lint_log.txt: List additional required output channels/values here
  • pipeline_todos - TODO string in lint_log.txt: Named file extensions MUST be emitted for ALL output channels
  • pipeline_todos - TODO string in lint_log.txt: List additional required output channels/values here
  • pipeline_todos - TODO string in lint_log.txt: Named file extensions MUST be emitted for ALL output channels
  • pipeline_todos - TODO string in lint_log.txt: List additional required output channels/values here
  • pipeline_todos - TODO string in lint_log.txt: Named file extensions MUST be emitted for ALL output channels
  • pipeline_todos - TODO string in lint_log.txt: List additional required output channels/values here
  • pipeline_todos - TODO string in lint_log.txt: Named file extensions MUST be emitted for ALL output channels
  • pipeline_todos - TODO string in lint_log.txt: List additional required output channels/values here
  • pipeline_todos - TODO string in lint_log.txt: Named file extensions MUST be emitted for ALL output channels
  • pipeline_todos - TODO string in lint_log.txt: List additional required output channels/values here
  • pipeline_todos - TODO string in README.md: Include a figure that guides the user through the major workflow steps. Many nf-core
  • pipeline_todos - TODO string in base.config: Check the defaults for all processes
  • pipeline_todos - TODO string in base.config: Customise requirements for specific processes.
  • pipeline_todos - TODO string in methods_description_template.yml: #Update the HTML below to your preferred methods description, e.g. add publication citation for this pipeline
  • pipeline_todos - TODO string in nextflow.config: Specify any additional parameters here
  • pipeline_todos - TODO string in meta.yml: #Add a description of the module and list keywords
  • local_component_structure - tumor_only_happhase.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - prepare_annotation.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - prepare_reference_files.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - tumor_normal_happhase.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure

❔ Tests ignored:

  • files_exist - File is ignored: CODE_OF_CONDUCT.md
  • files_exist - File is ignored: assets/nf-core-lrsomatic_logo_light.png
  • files_exist - File is ignored: docs/images/nf-core-lrsomatic_logo_light.png
  • files_exist - File is ignored: docs/images/nf-core-lrsomatic_logo_dark.png
  • files_exist - File is ignored: .github/ISSUE_TEMPLATE/config.yml
  • files_exist - File is ignored: .github/workflows/awstest.yml
  • files_exist - File is ignored: .github/workflows/awsfulltest.yml
  • nextflow_config - Config variable ignored: manifest.name
  • nextflow_config - Config variable ignored: manifest.homePage
  • files_unchanged - File ignored due to lint config: CODE_OF_CONDUCT.md
  • files_unchanged - File ignored due to lint config: .github/CONTRIBUTING.md
  • files_unchanged - File ignored due to lint config: .github/ISSUE_TEMPLATE/bug_report.yml
  • files_unchanged - File does not exist: .github/ISSUE_TEMPLATE/config.yml
  • files_unchanged - File ignored due to lint config: .github/PULL_REQUEST_TEMPLATE.md
  • files_unchanged - File ignored due to lint config: assets/email_template.txt
  • files_unchanged - File ignored due to lint config: assets/nf-core-lrsomatic_logo_light.png
  • files_unchanged - File ignored due to lint config: docs/images/nf-core-lrsomatic_logo_light.png
  • files_unchanged - File ignored due to lint config: docs/images/nf-core-lrsomatic_logo_dark.png
  • files_unchanged - File ignored due to lint config: docs/README.md
  • actions_awstest - 'awstest.yml' workflow not found: /home/runner/work/lrsomatic/lrsomatic/.github/workflows/awstest.yml
  • schema_params - schema_params

❔ Tests fixed:

✅ Tests passed:

Run details

  • nf-core/tools version 3.5.1
  • Run at 2026-01-08 09:39:46

@ljwharbers ljwharbers marked this pull request as ready for review December 29, 2025 14:33
Copilot AI review requested due to automatic review settings December 29, 2025 14:33
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

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 nf-core template to version 3.5.1, introducing major changes to versioning output using topic-based versioning for modules and updating meta.yml descriptions for tools/inputs/outputs.

Key Changes:

  • Migrates channel factory methods from Channel to channel (lowercase) throughout the codebase
  • Implements topic-based versioning system that collects versions via topics instead of mixing channel outputs
  • Updates module versions (samtools 1.21→1.22.1, longphase 1.7.3→2.0, mosdepth 0.3.10→0.3.11, modkit 0.4.4→0.6.0, multiqc 1.32→1.33, etc.)
  • Removes many ch_versions.mix() statements in favor of topic-based collection
  • Updates test snapshots with new md5 hashes and version numbers

Reviewed changes

Copilot reviewed 113 out of 118 changed files in this pull request and generated no comments.

Show a summary per file
File Description
workflows/lrsomatic.nf Main workflow updated with lowercase channel factory, topic-based versioning implementation, removed version mixing, fixed severus input to remove tbi parameter
tests/default.nf.test.snap Updated test snapshots with new tool versions and file hashes, removed SV_VEP output references
subworkflows/nf-core/utils_nfschema_plugin/main.nf Removed trailing whitespace
subworkflows/nf-core/bam_stats_samtools/main.nf Removed one version mixing statement
subworkflows/local/tumor_only_happhase.nf Channel factory updates, removed version mixing, fixed variable naming (snps→vcf), updated longphase output references
subworkflows/local/tumor_normal_happhase.nf Channel factory updates, removed version mixing, fixed variable naming, updated longphase output references, formatting fixes
subworkflows/local/prepare_reference_files.nf Channel factory method updates
subworkflows/local/prepare_annotation.nf Channel factory method updates
modules/nf-core/severus/ Major refactoring with prefix-based output paths, removed tbi input/output, updated meta.yml with detailed descriptions
modules/nf-core/samtools/*/ Updated to version 1.22.1 with topic-based versioning
modules/nf-core/longphase/*/ Updated to version 2.0 with separate SNV/SV/mod VCF outputs and indices
modules/nf-core/modkit/pileup/ Updated to 0.6.0, outputs bgzf-compressed bed files, removed bedgraph output
modules/nf-core/multiqc/ Updated to 1.33 with topic-based versioning
modules/nf-core/mosdepth/ Updated to 0.3.11
nextflow.config Added duplicate parameter definitions, renamed arm→arm64/emulate_amd64, removed gitpod profile, updated nf-schema plugin version, removed validation help config
nextflow_schema.json Added help, help_full, and show_hidden parameter definitions
ro-crate-metadata.json Updated dates and test suite IDs

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

@robert-a-forsyth robert-a-forsyth merged commit 0bf947e into dev Jan 8, 2026
7 checks passed
@ljwharbers ljwharbers deleted the template_351 branch January 8, 2026 13:35
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.

3 participants