Skip to content

Add support for metromap svgs for bump-versions#3978

Merged
Joon-Klaps merged 16 commits intonf-core:devfrom
Joon-Klaps:bump-versions-svg
Jan 13, 2026
Merged

Add support for metromap svgs for bump-versions#3978
Joon-Klaps merged 16 commits intonf-core:devfrom
Joon-Klaps:bump-versions-svg

Conversation

@Joon-Klaps
Copy link
Copy Markdown
Contributor

@Joon-Klaps Joon-Klaps commented Jan 8, 2026

PR checklist

More & more nf-core pipelines are having metromaps and add their versions to those metromaps, see search. Thought it might be interesting to update those files as well.

The tricky part is exporting those SVG files to PNG's & PDFs as I wasn't able to find good packages that export them without cairo. This means, the user needs to install cairo when wanting to export them (conda install cairo).

I don't know what your suggestions would be to continue with this? Do we (I) add the cairo to the bioconda package and throw a warning when installing with pip and a bump versions that cairo is missing? Or, (II) do we throw a warning in general, when svg's are found with versions in them that we cannot export them to png/pdf unless cairo installed nativly?

  • 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!
  • Documentation in docs is updated

@codecov
Copy link
Copy Markdown

codecov Bot commented Jan 8, 2026 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.67%. Comparing base (36cd310) to head (6f567d3).
⚠️ Report is 17 commits behind head on dev.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@mashehu
Copy link
Copy Markdown
Contributor

mashehu commented Jan 12, 2026

nice idea! had a similar problem when writing create_logo.py. my solution there was to have to separate workflows for svg and png, so will not work here.
I think handling only svg for now and printing a warning with update instruction if there are pngs with the same name should be enough for now.

@Joon-Klaps
Copy link
Copy Markdown
Contributor Author

Joon-Klaps commented Jan 13, 2026

Yeah, I tried to look for solutions within create_logo.py, but that didn't help. Ok, I'll then do as you suggested and throw a warning instead of exporting.

But can I include a try and catch block to try if cairo could be found, or do you feel like it will become to messy?

@mashehu
Copy link
Copy Markdown
Contributor

mashehu commented Jan 13, 2026

don't think it is worth the effort tbh. if i remember correctly in the past, using cairo wasn't the easiest thing either to get everything correct.

@Joon-Klaps Joon-Klaps marked this pull request as ready for review January 13, 2026 10:17
@Joon-Klaps Joon-Klaps requested a review from mashehu January 13, 2026 10:17
mashehu
mashehu approved these changes Jan 13, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@mashehu mashehu left a comment

Choose a reason for hiding this comment

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

Nice

@github-project-automation github-project-automation Bot moved this from Todo to In Progress in nf-core infrastructure projects Jan 13, 2026
@Joon-Klaps Joon-Klaps merged commit 23e8f89 into nf-core:dev Jan 13, 2026
114 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in nf-core infrastructure projects Jan 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mashehu mashehu mashehu approved these changes

Assignees

@Joon-Klaps Joon-Klaps

Labels

None yet

Projects

nf-core infrastructure projects
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Joon-Klaps @mashehu @mirpedrol