feat: Pre-commit hook for automatic parameters documentation generation#25
Conversation
2ab1b97 to
71f60d8
Compare
71f60d8 to
6cd386d
Compare
|
A good (better) alternative to this could also be the newly released nf-docs. |
beatrizsavinhas
left a comment
There was a problem hiding this comment.
This looks great! Thank you for showing it to us. 🌟
I will just confirm with the rest of the team if this is something we want to add and, if so, I can come back to approve it!
beatrizsavinhas
left a comment
There was a problem hiding this comment.
@Clinical-Genomics/cancer agrees this is a good feature to add!
Thank you again @fellen31 for the suggestion and work to add it here. 🌟
👍 Someone with admin access to the repo should edit the expected statuses that this PR affects. |
The required actions have been updated (since the test run was removed - |
So it's these two that were moved into the "lint" workflow.
|
Ah, of course! I will temporarily disable these restrictions so you can merge. And then will require the |
There was a problem hiding this comment.
The only relevant files for this PR are .prettierignore and .github/workflows/linting.yml, right? Is it possible that the rest of the changes were accidentally introduced when resolving merge conflicts after updating the branch?


If this is something you would like to have :), this PR adds:
nf-core pipelines schema docs -o docs/parameters.md --forcewhenevernextflow_schema.jsonis modified.See https://github.com/genomic-medicine-sweden/nf-core-schema-docs for more information.
PR checklist
nf-core pipelines lint).nextflow run . -profile test,docker --outdir <OUTDIR>).nextflow run . -profile debug,test,docker --outdir <OUTDIR>).docs/usage.mdis updated.docs/output.mdis updated.CHANGELOG.mdis updated.README.mdis updated (including new tool citations and authors/contributors).