8000 refractor: add nf-schema comment to the plugin import and sample sheet channel generation by rarestpreet · Pull Request #4497 · nf-core/tools · GitHub
[go: up one dir, main page]

Skip to content
  • refractor: add nf-schema comment to the plugin import and sample sheet channel generation - #4497

    Open
    rarestpreet wants to merge 1 commit into
    nf-core:devfrom
    rarestpreet:doc-refer-imports-sample-sheet-generation
    Open

    rarestpreet wants to merge 1 commit into
    nf-core:devfrom
    rarestpreet:doc-refer-imports-sample-sheet-generation

    Conversation

    @rarestpreet
    Copy link
    Copy Markdown

    Closes #2980

    Description of changes

    Following the migration to nf-schema, developers building new pipelines may not be aware of nf-schema or where to look up documentation. This PR adds explanatory code comments with links to the official nf-schema documentation in the pipeline template:

    1. Above plugin imports in subworkflows/local/utils_nfcore_pipeline_pipeline/main.nf:
      • Adds a comment referencing the nf-schema documentation website above the plugin/nf-schema includes.
    2. Above sample sheet channel generation in 8000 subworkflows/local/utils_nfcore_pipeline_pipeline/main.nf:
      • Adds a comment linking to documentation for channel generation from sample sheets when nf_schema is enabled.

    Both comments are guarded by {% if nf_schema %} so they are only included when the nf_schema template feature is active.

    PR checklist

    • This comment contains a description of changes (with reason)
    • CHANGELOG.md is updated
    • If you've fixed a bug or added code that should be tested, add tests! (Checked with existing pipeline creation tests)
    • Documentation in docs is updated

    @mashehu mashehu added this to the 4.3.0 milestone Oct 9, 2026

    This branch has not been deployed

    No deployments
    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.

    2 participants

    0