Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

(aws-cdk-lib): v2 release notes broken #16802

Closed
njlynch opened this issue Oct 5, 2021 · 2 comments · Fixed by #16942
Closed

(aws-cdk-lib): v2 release notes broken #16802

njlynch opened this issue Oct 5, 2021 · 2 comments · Fixed by #16942
Assignees
@njlynch
Labels
aws-cdk-lib Related to the aws-cdk-lib package bug This issue is a bug. docs/repo-general Related to repo documentation (CONTRIBUTING, CODE_OF_CONDUCT, etc.) effort/medium Medium work item – several days of effort p1
Milestone
[GA] CDK V2

Comments

@njlynch
Copy link
Contributor

njlynch commented Oct 5, 2021

What is the problem?

Starting with release https://github.com/aws/aws-cdk/releases/tag/v2.0.0-rc.22, the V2 changelog has stopped working. Rather than seeing a mirror of the V1 release notes, or the V2 stable-only changes (or the proposed combination of both -- see https://github.com/aws/aws-cdk-rfcs/blob/master/text/0249-v2-experiments.md#changelog--release-notes), the notes are blank.

Ideally, the fix would be to implement the suggestion in the above RFC. At the minimum, showing the changes only present in CHANGELOG.v2.md would be better than the current state.

Reproduction Steps

Release the CDK v2.

What did you expect to happen?

Better things.

What actually happened?

Bad things.

CDK CLI Version

All of them.

Framework Version

No response

Node.js Version

All of them

OS

All of them

Language

Typescript, Python, .NET, Java, Go

Language Version

No response

Other information

No response
@njlynch njlynch added bug This issue is a bug. needs-triage This issue or PR still needs to be triaged. labels Oct 5, 2021
@njlynch njlynch added this to the [GA] CDK V2 milestone Oct 5, 2021
@njlynch njlynch self-assigned this Oct 5, 2021
@njlynch njlynch added docs/repo-general Related to repo documentation (CONTRIBUTING, CODE_OF_CONDUCT, etc.) effort/small Small work item – less than a day of effort p1 and removed needs-triage This issue or PR still needs to be triaged. labels Oct 5, 2021
@njlynch njlynch removed their assignment Oct 5, 2021
@github-actions github-actions bot added the aws-cdk-lib Related to the aws-cdk-lib package label Oct 5, 2021
@njlynch
Copy link
Contributor Author

njlynch commented Oct 11, 2021

High-level proposed plan:

Currently in aws-delivlib, there is a GitHub publishing script which either looks at CHANGELOG.md (or an alternative file passed in an environment variable), parses it to a current version, and then posts the result as the release notes.

The proposed plan would be to add an environment variable (e.g., RELEASE_NOTES) to the job. If this environment variable is present and points to a valid file, the contents of that file will be used (verbatim), rather than the parsed data from the changelog.

During the CDK build, we can generate the release notes file from the combination of the CHANGELOG.v2.md and CHANGELOG.v2.alpha.md, as defined in the RFC. This can be an ephemeral build output that doesn't need to be stored in source (and can be in .gitignore).

It's worth noting that if the above is a multi-day effort, in the short-term we can set the CHANGELOG environment variable to CHANGELOG.v2.md, which will fix the release notes to show only the stable (aws-cdk-lib) changes. Then we can do the above for the "correct" change.

@njlynch njlynch assigned njlynch and unassigned nija-at Oct 11, 2021
@njlynch njlynch added effort/medium Medium work item – several days of effort and removed effort/small Small work item – less than a day of effort labels Oct 12, 2021
@njlynch njlynch mentioned this issue Oct 13, 2021
Merged
njlynch added a commit that referenced this issue Oct 13, 2021
@njlynch
chore(cdk-release): create our release notes as part of the build
0132242 
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

fixes #16802
njlynch added a commit that referenced this issue Oct 13, 2021
@njlynch
chore(cdk-release): create our release notes as part of the build
fb23802 
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

fixes #16802
@njlynch njlynch mentioned this issue Oct 13, 2021
Merged
njlynch added a commit that referenced this issue Oct 13, 2021
@njlynch
chore(cdk-release): create our release notes as part of the build
510c141 
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

fixes #16802
@mergify mergify bot closed this as completed in #16942 Oct 13, 2021
mergify bot pushed a commit that referenced this issue Oct 13, 2021
@njlynch
chore(cdk-release): create our release notes as part of the build (#1…
2f0140e 
…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*
@github-actions
Copy link

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

TikiTDO pushed a commit to TikiTDO/aws-cdk that referenced this issue Feb 21, 2022
@njlynch @TikiTDO
chore(cdk-release): create our release notes as part of the build (aw…
1ce4a37 
…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*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@njlynch njlynch

Labels
aws-cdk-lib Related to the aws-cdk-lib package bug This issue is a bug. docs/repo-general Related to repo documentation (CONTRIBUTING, CODE_OF_CONDUCT, etc.) effort/medium Medium work item – several days of effort p1
Projects
None yet
Milestone
[GA] CDK V2
Development

Successfully merging a pull request may close this issue.

chore(cdk-release): create our release notes as part of the build aws/aws-cdk
2 participants
@njlynch @nija-at