Conversation
Add a new opt-in `metro_map` template feature that ships a starter metro-map diagram and keeps its rendered images in sync with nf-metro. - assets/metro_map.mmd: starter tube-map built from the template flow (FastQC / MultiQC), adapting to the fastqc/multiqc feature toggles. All outputs and their per-file options (animation, colour mode) are declared in the .mmd via %%metro output:, so no CLI flags are needed. - Renders four images to docs/images/ at create time (static + animated SVG, light + dark PNG) via nf-metro, matching the Action/hook defaults so there is no first-push churn. - .github/workflows/metro-map.yml: regenerate images on .mmd change or workflow_dispatch and commit them back. - Pre-commit hook (seqeralabs/nf-metro) keeps the images in sync locally. - Register the static SVG as manifest.diagram and show the animated SVG in the README. - New `metro_map` feature toggle (default on) so it can be skipped independently of nf-core module usage. - Add nf-metro as a dependency. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The pre-commit hook and create-time render keep the images in sync; the CI Action can follow in a separate PR. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Regenerate the metro-map images on .mmd change or workflow_dispatch and commit them back, complementing the pre-commit hook. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
prettier cannot parse the `{% %}` Jinja tags in the template's
metro-map.yml and .pre-commit-config.yaml, matching how the other
Jinja-containing template workflows are already ignored.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Member
Author
|
CI tests will fail until nf-metro 2.2.0 is released with the new |
maxulysse
reviewed
Sep 22, 2026
Co-authored-by: Maxime U Garcia <max.u.garcia@gmail.com>
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds a new opt-in
metro_maptemplate feature that gives every new pipeline a starter nf-metro map workflow diagram, plus the automation to keep its rendered images in sync. This builds on the recentmanifest.diagramsupport (#4460).Adds the following:
assets/metro_map.mmd: a starter tube-map with FastQC + MultiQCdocs/images/at pipeline-creation time via nf-metro: a static SVG, an animated SVG, and light/dark PNGs.seqeralabs/nf-metropre-commit hook keeps the images in sync whenever the.mmdchanges.manifest.diagramis still commented out with aTODO, as is the animated SVG is shown in theREADME(to avoid many identical boilerplate maps).nf-metroadded as a dependency (it is self-contained —resvg-py+pillow, no browser).Note
This depends on nf-metro's
%%metro output:per-file overrides and the repo-root scoping of--reject-output-outside-source, both of which are now upstream but not yet released.PR checklist
CHANGELOG.mdis updateddocsis updatednf-core pipelines lintpasses on a generated pipeline🤖 Generated with Claude Code