Add CHANGELOG and document the update process#2899
Closed
cconstable wants to merge 2 commits into
Closed
Conversation
Add a CHANGELOG.md with an Unreleased section, set CHANGELOG.md to merge=union via .gitattributes, and document in CONTRIBUTING.md when and how to add entries.
Author
|
@maciejdudko What do we want to do with the previous releases? From our chat earlier, it sounded like having every repo move towards a consistent changelog was the plan. I could write a little script to backfill the changelog with the contents of the old release notes and then remove them so there isn't confusion about which to use. We could also "archive" them somehow so they are still visible in the repo. Or we could revisit this conversation for Java. |
Contributor
|
There are some special considerations for Java given our semi-automated release flow due to which Java changelog file should probably be handled differently from other SDKs. Let's flesh out the plan more and get back to it another time. |
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
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.
What
Adds a
CHANGELOG.mdand a lightweight process for keeping it current.CHANGELOG.mdat the repo root with an## [Unreleased]section, looselyfollowing the Keep a Changelog format.
Entries are grouped under free-form headings (Added, Changed, Deprecated,
Breaking Changes, Fixed, Security), created as needed.
.gitattributesmarksCHANGELOG.mdasmerge=unionso entries added byconcurrent PRs append instead of conflicting.
CONTRIBUTING.mddocuments when to add an entry (any user-facing change)and how.
Why
Today release drivers reconstruct notes by hand at release time. Capturing
high-level notes incrementally in each PR makes releases faster and more
reliable: the GitHub release notes become the
[Unreleased]section plus thecommit log.
Notes
historical release notes remain available through GitHub Releases.