Add regression tests for changelog text manipulation #12
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
This is what I get for being so terse with #6 and #7...
This actually fixes the issue I ran into with /~https://github.com/uclahs-cds/tool-BoutrosLab-utils/pull/23. The auto-generated links at the end had extra
v
s:I thought I fixed that with #7, but that would have resulted in these links (the first one is broken):
The real issue was that the changelog included
v0.0.1
as a version, which is what this PR fixes.The README now includes a note that versions must begin with a digit, and that the corresponding git tags must begin with a
v
. The actual fix for #6 is to strip leadingv
s from versions in the changelog, and go back to appending thatv
when constructing the tag links.To make this more explicit I added some regression tests with bundled changelog files. The "original" file includes non-standard formatting and
v2.5.0
as a version. The formatted file is the result of parsing and re-serializing the original, and shows thatv2.5.0
is changed to2.5.0
. Finally, there is an updated file with a minor version bump.Diff between `original` and `formatted`
Diff between `formatted` and `2.5.3`
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. ↩