CI & automation
Commit a metro-map .mmd to your pipeline repo and let automation keep the
rendered SVG in sync. nf-metro ships three integration modes:
- a composite GitHub Action — install + render, you decide what to do with the result;
- a reusable workflow — the same, plus commit-on-push / warn-on-PR out of the box;
- a pre-commit hook — re-render locally on every commit.
GitHub Action
Section titled “GitHub Action”The composite action uses nf-metro to render the map, and reports whether the SVG changed.
- uses: actions/checkout@v4- uses: seqeralabs/nf-metro@1.1.0 id: metro with: input: assets/metro_map.mmd theme: nfcore embed-font: "true"# steps.metro.outputs.output-path — where the SVG was written# steps.metro.outputs.changed — 'true' when it differs from the committed SVGInputs (all optional): input (default assets/metro_map.mmd), output
(default: the sibling .svg of the input), theme (default nfcore), mode,
embed-font (default true), version (nf-metro version to install), and
extra-args for any other nf-metro render flag (e.g.
extra-args: "--fold-threshold 20").