chore: fix CHANGELOG generation for v2 branch #13019
Merged
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
The CHANGELOG for the v2 releases has been inaccurate, only showing a fraction of the changes and mixing v1 and v2 releases side by side. The issue appears to be how `conventional-changelog` handles interleaving changes across major versions on separate branches. After digging into the internals of conventional-changelog and standard-release a bit, I don't see a supported way to achieve our desired outcome. However, I did come up with a hack that results in the right end result. By (locally) removing all v1.* tags, and running the release, a correct CHANGELOG is created. Likewise, on the master/v1 branch, removing v2.* tags prior to bumping does not appear to have any adverse effects. I would be thrilled for someone to point out the option(s) that I missed to do this more elegantly, but for now this seems to work. I also took the liberty of re-generating the v2 CHANGELOG for the previous releases using this fix, to show what the correct output should look like. I will backport the changes to bump.js to master once this has been shipped.
|
|
rix0rrr
approved these changes
Feb 15, 2021
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
njlynch
added a commit
that referenced
this pull request
Feb 16, 2021
See #13019 for the original fix, which was committed to the v2-main branch. This backports the change to the master/v1 branch.
mergify bot
pushed a commit
that referenced
this pull request
Feb 16, 2021
See #13019 for the original fix, which was committed to the v2-main branch. This backports the change to the master/v1 branch. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
NovakGu
pushed a commit
to NovakGu/aws-cdk
that referenced
this pull request
Feb 18, 2021
See aws#13019 for the original fix, which was committed to the v2-main branch. This backports the change to the master/v1 branch. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
eladb
pushed a commit
that referenced
this pull request
Feb 22, 2021
See #13019 for the original fix, which was committed to the v2-main branch. This backports the change to the master/v1 branch. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
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.
The CHANGELOG for the v2 releases has been inaccurate, only showing a fraction
of the changes and mixing v1 and v2 releases side by side.
The issue appears to be how
conventional-changeloghandles interleavingchanges across major versions on separate branches. After digging into the
internals of conventional-changelog and standard-release a bit, I don't see a
supported way to achieve our desired outcome.
However, I did come up with a hack that results in the right end result. By
(locally) removing all v1.* tags, and running the release, a correct CHANGELOG
is created. Likewise, on the master/v1 branch, removing v2.* tags prior to
bumping does not appear to have any adverse effects.
I would be thrilled for someone to point out the option(s) that I missed to do
this more elegantly, but for now this seems to work.
I also took the liberty of re-generating the v2 CHANGELOG for the previous
releases using this fix, to show what the correct output should look like.
I will backport the changes to bump.js to master once this has been shipped.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license