Update documentation URLs for tags, add script to backfill docs #15
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Okay, I should be done with this action after this. There are two related things happening with this PR:
Script to backfill docs for existing tags
The first change in this PR is to add a script that clones a pipeline, builds the documentation for each tag, previews it for you locally, and gives you the opportunity to push the changes up to GitHub.
I already ran this script for pipeline-recalibrate-BAM and pushed the changes up (https://improved-bassoon-j5jkeer.pages.github.io/release-candidate/), and in doing so discovered a few things I wanted to improve. Those fixes are the second half of this PR discussed below.
Updated repository and edit links
There are two links to GitHub on each docs page: an "Edit on GitHub" link in the upper right, and a "GitHub" link in the lower left.
Currently the "Edit on GitHub" link always refers to the version's commit hash, like https://github.com/uclahs-cds/pipeline-align-DNA/blob/023fdba7e1a875e6893e40d5fc7609c51ef12118/README.md. The "GitHub" link always points to the main page, like https://github.com/uclahs-cds/pipeline-align-DNA.
This change makes it so that tagged versions have better contextual links, like https://github.com/uclahs-cds/pipeline-align-DNA/blob/v9.0.0/README.md and https://github.com/uclahs-cds/pipeline-align-DNA/tree/v9.0.0. The two advantages there are:
development
release will still point to the main page.Before
(I know, the hashes don't match,
development
andv9.0.0
aren't actually the same commit.)After
Checklist
This PR does NOT contain Protected Health Information (PHI). A repo may need to be deleted if such data is uploaded.
Disclosing PHI is a major problem1 - Even a small leak can be costly2.
This PR does NOT contain germline genetic data3, RNA-Seq, DNA methylation, microbiome or other molecular data4.
.png
, .jpeg
),.pdf
,.RData
,.xlsx
,.doc
,.ppt
, or other output files.To automatically exclude such files using a .gitignore file, see here for example.
I have read the code review guidelines and the code review best practice on GitHub check-list.
I have set up or verified the
main
branch protection rule following the github standards before opening this pull request.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].
I have added the major changes included in this pull request to the
CHANGELOG.md
under the next release version or unreleased, and updated the date.Footnotes
UCLA Health reaches $7.5m settlement over 2015 breach of 4.5m patient records ↩
The average healthcare data breach costs $2.2 million, despite the majority of breaches releasing fewer than 500 records. ↩
Genetic information is considered PHI.
Forensic assays can identify patients with as few as 21 SNPs ↩
RNA-Seq, DNA methylation, microbiome, or other molecular data can be used to predict genotypes (PHI) and reveal a patient's identity. ↩