Update: Major version changelogs include all prereleases #37
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
For a new stable release following a prerelease sequence, the changelog will include the commits for all of the prereleases going back to the last stable release. For example, given the following release sequence: - 6.7.8 - 6.8.0 - 7.0.0-alpha.0 - 7.0.0-alpha.1 - 7.0.0 The `7.0.0` changelog will include all changes since 6.8.0, whereas the `7.0.0-alpha.1` changelog will include only changes since `7.0.0-alpha.0`. If we prefer to include all changes going back to the previous stable release even for prerelease changelogs, that's an easy change and actually simplifies the logic a bit.
btmills
commented
May 8, 2020
| @@ -252,6 +284,36 @@ describe("ReleaseOps", () => { | |||
| }); | |||
| }); | |||
|
|
|||
| it("should create the next stable release following a prerelease", () => { | |||
There was a problem hiding this comment.
Previously, assuming our last prerelease before a stable major release was a release candidate, the stable release's changelog would've only included changes since the release candidate. At that phase of the release, breaking changes are discouraged. Now that we're including breaking changes in the stable release's changelog, I added this test to verify that the version bump won't mistakenly go from 7.0.0-rc.0 to 8.0.0 when it sees a Breaking: commit in the changelog for a release following a release candidate.
nzakas
approved these changes
May 8, 2020
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.
For a new stable release following a prerelease sequence, the changelog will include the commits for all of the prereleases going back to the last stable release. For example, given the following release sequence:
The
7.0.0changelog will include all changes since6.8.0, whereas the7.0.0-alpha.1changelog will include only changes since7.0.0-alpha.0.If we prefer to include all changes going back to the previous stable release even for prerelease changelogs, that's an easy change and actually simplifies the logic a bit.