feat: support release notes for GitHub publishing #1044
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
Currently, the GitHub publishing job looks for a CHANGELOG file (either in a default location or set by environment variable), parses the changelog for the current version, and uses that result as the release notes. This change enables an alternative approach; creating a RELEASE_NOTES file which contains the complete release notes, ready for publishing. The advantage of this new approach might be if you want to do some post-processing formatting on the changelog (or even include extra notes not normally present in the default changelog). For CDKv2, this will be used to combine the changelog entries for the stable release (aws-cdk-lib) and for the alpha modules.
rix0rrr
approved these changes
Oct 13, 2021
mergify bot
pushed a commit
to aws/aws-cdk
that referenced
this pull request
Oct 13, 2021
…6942) Currently, our bump process creates `CHANGELOG.md` for the `master` branch, and `CHANGELOG.v2.md` and `CHANGELOG.v2.alpha.md` on the `v2-main` branch. For the latter, we need to combine the two changelogs into one for the GitHub release, where all of the artifacts of the release (both aws-cdk-lib and all the alpha modules) are bundled together. As proposed in the [RFC], this combined format shows the stable/aws-cdk-lib changes first, and then the alpha module changes under their own heading. This generated -- but not saved -- RELEASE_NOTES.md will be used by our publishing pipeline to generate the GitHub release notes. [RFC]: https://github.com/aws/aws-cdk-rfcs/blob/master/text/0249-v2-experiments.md#changelog--release-notes See companion PR - cdklabs/aws-delivlib#1044 fixes #16802 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
njlynch
added a commit
to aws/aws-cdk
that referenced
this pull request
Oct 22, 2021
We now create and generate a `RELEASE_NOTES.md` file as part of our build, with the intent to use it for our GitHub release publishing. See (#16942) and cdklabs/aws-delivlib#1044. What I missed is that after the build, we pack, and then only include what ends up in `./dist` in the final build artifact that goes to publishing. This fix includes the release notes in the dist folder so it will be picked up and used by the release process.
mergify bot
pushed a commit
to aws/aws-cdk
that referenced
this pull request
Oct 22, 2021
We now create and generate a `RELEASE_NOTES.md` file as part of our build, with the intent to use it for our GitHub release publishing. See (#16942) and cdklabs/aws-delivlib#1044. What I missed is that after the build, we pack, and then only include what ends up in `./dist` in the final build artifact that goes to publishing. This fix includes the release notes in the dist folder so it will be picked up and used by the release process. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
mergify bot
pushed a commit
to aws/aws-cdk
that referenced
this pull request
Oct 22, 2021
We now create and generate a `RELEASE_NOTES.md` file as part of our build, with the intent to use it for our GitHub release publishing. See (#16942) and cdklabs/aws-delivlib#1044. What I missed is that after the build, we pack, and then only include what ends up in `./dist` in the final build artifact that goes to publishing. This fix includes the release notes in the dist folder so it will be picked up and used by the release process. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license* (cherry picked from commit 260df31)
TikiTDO
pushed a commit
to TikiTDO/aws-cdk
that referenced
this pull request
Feb 21, 2022
…s#16942) Currently, our bump process creates `CHANGELOG.md` for the `master` branch, and `CHANGELOG.v2.md` and `CHANGELOG.v2.alpha.md` on the `v2-main` branch. For the latter, we need to combine the two changelogs into one for the GitHub release, where all of the artifacts of the release (both aws-cdk-lib and all the alpha modules) are bundled together. As proposed in the [RFC], this combined format shows the stable/aws-cdk-lib changes first, and then the alpha module changes under their own heading. This generated -- but not saved -- RELEASE_NOTES.md will be used by our publishing pipeline to generate the GitHub release notes. [RFC]: https://github.com/aws/aws-cdk-rfcs/blob/master/text/0249-v2-experiments.md#changelog--release-notes See companion PR - cdklabs/aws-delivlib#1044 fixes aws#16802 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
TikiTDO
pushed a commit
to TikiTDO/aws-cdk
that referenced
this pull request
Feb 21, 2022
We now create and generate a `RELEASE_NOTES.md` file as part of our build, with the intent to use it for our GitHub release publishing. See (aws#16942) and cdklabs/aws-delivlib#1044. What I missed is that after the build, we pack, and then only include what ends up in `./dist` in the final build artifact that goes to publishing. This fix includes the release notes in the dist folder so it will be picked up and used by the release process. ---- *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.
Currently, the GitHub publishing job looks for a CHANGELOG file (either in a
default location or set by environment variable), parses the changelog for the
current version, and uses that result as the release notes. This change enables
an alternative approach; creating a RELEASE_NOTES file which contains the
complete release notes, ready for publishing.
The advantage of this new approach might be if you want to do some
post-processing formatting on the changelog (or even include extra notes not
normally present in the default changelog). For CDKv2, this will be used to
combine the changelog entries for the stable release (aws-cdk-lib) and for the
alpha modules.
related aws/aws-cdk#16802
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.