This adds the documentation action from https://github.com/uclahs-cds/tool-Nextflow-action/pull/13. Nothing should happen until this PR is merged, then the documentation should be updated automatically on every update to main and every tag creation.
Assuming there are no problems with this, after merging I'm going to back-fill documentation for the existing tags.
Testing Results
This is a documentation-only change and has no impact on the pipeline itself.
[x] The name of the branch is meaningful and well formatted following the standards, using [AD_username (or 5 letters of AD if AD is too long)]-[brief_description_of_branch].
[x] I have set up or verified the branch protection rule following the github standards before opening this pull request.
[x] I have added my name to the contributors listings in the manifest block in the nextflow.config as part of this pull request, am listed
already, or do not wish to be listed. (This acknowledgement is optional.)
[x] I have added the changes included in this pull request to the CHANGELOG.md under the next release version or unreleased, and updated the date.
[ ] I have updated the version number in the metadata.yaml and manifest block of the nextflow.config file following semver, or the version number has already been updated. (Leave it unchecked if you are unsure about new version number and discuss it with the infrastructure team in this PR.)
[x] I have tested the pipeline using NFTest, or I have justified why I did not need to run NFTest above.
Description
This adds the documentation action from https://github.com/uclahs-cds/tool-Nextflow-action/pull/13. Nothing should happen until this PR is merged, then the documentation should be updated automatically on every update to
main
and every tag creation.Assuming there are no problems with this, after merging I'm going to back-fill documentation for the existing tags.
Testing Results
This is a documentation-only change and has no impact on the pipeline itself.
Checklist
[x] I have read the code review guidelines and the code review best practice on GitHub check-list.
[x] I have reviewed the Nextflow pipeline standards.
[x] The name of the branch is meaningful and well formatted following the standards, using [AD_username (or 5 letters of AD if AD is too long)]-[brief_description_of_branch].
[x] I have set up or verified the branch protection rule following the github standards before opening this pull request.
[x] I have added my name to the contributors listings in the
manifest
block in thenextflow.config
as part of this pull request, am listed already, or do not wish to be listed. (This acknowledgement is optional.)[x] I have added the changes included in this pull request to the
CHANGELOG.md
under the next release version or unreleased, and updated the date.[ ] I have updated the version number in the
metadata.yaml
andmanifest
block of thenextflow.config
file following semver, or the version number has already been updated. (Leave it unchecked if you are unsure about new version number and discuss it with the infrastructure team in this PR.)[x] I have tested the pipeline using NFTest, or I have justified why I did not need to run NFTest above.