When generating a stacked changelog, note which branch/es contain a commit #14728
Conversation
This file contains 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
…ommit New-TerminalStackedChangelog used to generate logs that looked like this: ``` * [3] A commit that was seen 3 times * A commit that was only seen once * [2] Some other commit ``` Now it will generate logs that look like this: ``` / base..branch-1 |/ base..branch-2 ||/ base..branch-3 * [XXX] A commit that was seen 3 times * [ X ] A commit that was only seen once * [XX ] Some other commit ``` This format is more expressive, as it indicates _which branches_ contain which commits. As a reminder, my release note writing style starts with a stacked changelog. It's how I tell (1) which commits are in the new preview release only, (2) which commits are in the new preview and the new stable release and (3) which commits were already released in a previous stable release. Changes from 1 get included in the new changelog, changes from 2 get included in both and changes from 3 get deleted because they have already been released.
DHowett
commented
Jan 24, 2023
lhecker
approved these changes
Jan 25, 2023
carlos-zamora
approved these changes
Jan 25, 2023
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.
New-TerminalStackedChangelog used to generate logs that looked like this:
Now it will generate logs that look like this:
This format is more expressive, as it indicates which branches contain which commits.
As a reminder, my release note writing style starts with a stacked changelog. It's how I tell (1) which commits are in the new preview release only, (2) which commits are in the new preview and the new stable release and (3) which commits were already released in a previous stable release.
Changes from 1 get included in the new changelog, changes from 2 get included in both and changes from 3 get deleted because they have already been released.