Add security patch release process documentation#5987
Merged
chrisd8088 merged 5 commits intogit-lfs:mainfrom Feb 14, 2025
Merged
Add security patch release process documentation#5987chrisd8088 merged 5 commits intogit-lfs:mainfrom
chrisd8088 merged 5 commits intogit-lfs:mainfrom
Conversation
In the documentation of our release processes, we describe our release types using the capitalized terms MAJOR, MINOR, and PATCH; however, we do not capitalize the term PATCH consistently, so we adjust that now. As well, we also add language identifiers to several Markdown code blocks with currently lack them.
The documentation of our standard and patch release processes does not, at present, include the steps required to build a security patch release, so we add two sections which describe how we build such releases. The first new section documents our normal security patch release process, which applies when we do not need to coordinate our release with other projects, or at least do not need to build release assets in private while under a publication embargo. The second new section details the process of building new Git LFS release binaries in private, so they can be shared with other downstream projects while we are under an embargo on the publication of the security vulnerability and associated security patch release.
180eb6c to
c13fd27
Compare
larsxschneider
approved these changes
Feb 14, 2025
Member
larsxschneider
left a comment
There was a problem hiding this comment.
Thank you so much for writing these detailed instructions @chrisd8088 🙇🙇🙇!
That will be super helpful in the future!
As suggested in PR review, we revise our new security patch release documentation to more fully clarify the format and wording of the security message banners we publish on the git-lfs.com home page, and to improve one other bit of wording in our new instructions.
As suggested in PR review, we can rephrase the first step in the new documentation of our embargoed security release process to be more clear and concise, so we do that now.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The documentation of our standard and patch release processes does not, at present, include the steps required to build a security patch release, so we add two sections which describe how we build such releases.
The first new section documents our normal security patch release process, which applies when we do not need to coordinate our release with other projects, or at least do not need to build release assets in private while under a publication embargo.
The second new section details the process of building new Git LFS release binaries in private, so they can be shared with other downstream projects while we are under an embargo on the publication of the security vulnerability and associated security patch release.