Skip to content

Fix modules meta.yml file structure#3532

Merged
mirpedrol merged 21 commits intonf-core:devfrom
mirpedrol:meta-yml-tuple-structure
Jul 7, 2025
Merged

Fix modules meta.yml file structure#3532
mirpedrol merged 21 commits intonf-core:devfrom
mirpedrol:meta-yml-tuple-structure

Conversation

@mirpedrol
Copy link
Copy Markdown
Member

@mirpedrol mirpedrol commented Apr 7, 2025

Close: #3248

Code to fix/update:

@mirpedrol mirpedrol marked this pull request as ready for review April 17, 2025 09:29
@mirpedrol
Copy link
Copy Markdown
Member Author

The modules from GitLab, which we use for the CI tests, need to be fixed. But fixing this will break all other tools' tests. So I will mark the PR for review and fix the tests right before merging.
This should be a coordinated merge together with the PR on the website and the modules repo + an additional PR updating all modules to avoid linting errors there (the modules repo uses the dev version). And I would do all this before the release, to prevent people contributing to modules from having to use the dev version of tools.

Comment thread nf_core/components/nfcore_component.py Outdated
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.

didn't we want to do this with pydantic?

Comment thread nf_core/modules/lint/meta_yml.py Outdated
@mirpedrol
Copy link
Copy Markdown
Member Author

didn't we want to do this with pydantic?

Yes! I have been trying, but I can't find a way to use the ruamel.yaml.comments.CommentedMap type, which we need to add and maintain comments in the template.
I have followed the Pydantic docs on handling third-party types, but this will validate the CommentedMap and always return a dict, and we can't add comments to a dict. Do you know of a way to use CommentedMap?

@mashehu
Copy link
Copy Markdown
Contributor

mashehu commented May 6, 2025

can you make a new branch with the pydantic approach, so that I can have a look?

Comment thread nf_core/components/create.py Outdated
@mirpedrol
Copy link
Copy Markdown
Member Author

@nf-core-bot fix linting please!

Comment thread nf_core/components/create.py
Comment thread nf_core/components/create.py
Comment thread nf_core/components/nfcore_component.py Outdated
Comment thread nf_core/components/nfcore_component.py Outdated
Comment thread tests/modules/test_create.py Outdated
Comment thread CHANGELOG.md Outdated
Comment thread nf_core/components/nfcore_component.py Outdated
Comment thread nf_core/components/nfcore_component.py Outdated
Comment thread nf_core/components/nfcore_component.py Outdated
Comment thread tests/modules/test_create.py Outdated
Comment thread tests/modules/test_create.py Outdated
Comment thread tests/modules/test_create.py Outdated
Comment thread tests/modules/test_create.py Outdated
Comment thread tests/modules/test_create.py Outdated
Comment thread tests/modules/test_create.py Outdated
Comment thread tests/modules/test_create.py Outdated
@mirpedrol mirpedrol merged commit 47e667d into nf-core:dev Jul 7, 2025
97 of 98 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

3 participants