Skip to content

feat: Pre-commit hook for automatic parameters documentation generation#25

Merged
fellen31 merged 8 commits intoClinical-Genomics:devfrom
fellen31:parameters-documentation-hook
Mar 10, 2026
Merged

feat: Pre-commit hook for automatic parameters documentation generation#25
fellen31 merged 8 commits intoClinical-Genomics:devfrom
fellen31:parameters-documentation-hook

Conversation

@fellen31
Copy link
Contributor

@fellen31 fellen31 commented Feb 23, 2026

If this is something you would like to have :), this PR adds:

  • Parameters documentation
  • A pre-commit hook to automatically generate this via nf-core pipelines schema docs -o docs/parameters.md --force whenever nextflow_schema.json is modified.

See https://github.com/genomic-medicine-sweden/nf-core-schema-docs for more information.

PR checklist

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the pipeline conventions in the contribution docs
  • If necessary, also make a PR on the nf-core/oncorefiner branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core pipelines lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • Usage Documentation in docs/usage.md is updated.
  • Output Documentation in docs/output.md is updated.
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

@fellen31 fellen31 force-pushed the parameters-documentation-hook branch 2 times, most recently from 2ab1b97 to 71f60d8 Compare February 23, 2026 14:14
@fellen31 fellen31 force-pushed the parameters-documentation-hook branch from 71f60d8 to 6cd386d Compare February 23, 2026 14:15
@fellen31 fellen31 changed the title Pre-commit hook for automatic parameters documentation generation feat: Pre-commit hook for automatic parameters documentation generation Feb 25, 2026
@fellen31 fellen31 marked this pull request as ready for review February 25, 2026 15:46
@fellen31 fellen31 requested a review from a team as a code owner February 25, 2026 15:46
@fellen31
Copy link
Contributor Author

fellen31 commented Mar 5, 2026

A good (better) alternative to this could also be the newly released nf-docs.

Copy link
Contributor

@beatrizsavinhas beatrizsavinhas left a comment

Choose a reason for hiding this comment

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

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 beatrizsavinhas linked an issue Mar 5, 2026 that may be closed by this pull request
28 tasks
Copy link
Contributor

@beatrizsavinhas beatrizsavinhas left a comment

Choose a reason for hiding this comment

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

@Clinical-Genomics/cancer agrees this is a good feature to add!
Thank you again @fellen31 for the suggestion and work to add it here. 🌟

@fellen31
Copy link
Contributor Author

fellen31 commented Mar 9, 2026

@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.

@beatrizsavinhas
Copy link
Contributor

beatrizsavinhas commented Mar 10, 2026

@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 - ci.yml was removed with the template update in #35)!
I think that if you update your branch and resolve the conflicts, you should be able to merge! But let us know if the issue persists.

@fellen31
Copy link
Contributor Author

@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 - ci.yml was removed with the template update in #35)! I think that if you update your branch and resolve the conflicts, you should be able to merge! But let us know if the issue persists.

So it's these two that were moved into the "lint" workflow.

Screenshot 2026-03-10 at 09 47 42

@beatrizsavinhas
Copy link
Contributor

@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 - ci.yml was removed with the template update in #35)! I think that if you update your branch and resolve the conflicts, you should be able to merge! But let us know if the issue persists.

So it's these two that were moved into the "lint" workflow.

Screenshot 2026-03-10 at 09 47 42

Ah, of course! I will temporarily disable these restrictions so you can merge. And then will require the lint check instead!

@fellen31 fellen31 merged commit 3df2b22 into Clinical-Genomics:dev Mar 10, 2026
4 checks passed
@fellen31 fellen31 deleted the parameters-documentation-hook branch March 10, 2026 09:57
Copy link
Contributor

Choose a reason for hiding this comment

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

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?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh no! Fixing in #41

fellen31 added a commit to fellen31/oncorefiner that referenced this pull request Mar 10, 2026
fellen31 added a commit to fellen31/oncorefiner that referenced this pull request Mar 10, 2026
fellen31 added a commit to fellen31/oncorefiner that referenced this pull request Mar 10, 2026
fellen31 added a commit that referenced this pull request Mar 10, 2026
### Fixed

- Merge mistake introduced in #25
@beatrizsavinhas beatrizsavinhas mentioned this pull request Mar 12, 2026
28 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update documentation

3 participants