chore(cdk-release): support separate alpha Changelog#16182
chore(cdk-release): support separate alpha Changelog#16182mergify[bot] merged 8 commits intomasterfrom
Conversation
This is part of the continued work to release the experimental modules as independent alpha modules. This change introduces a new mode for handling changes in the changelog: in this new mode, all experimental features are still stripped from the main changelog (as they are currently for v2), but individual changelogs are also created for each experimental package to show the changes specific to those packages. I _believe_ the final behavior should be that the experimental changes are also included in the main changelog, under a new heading, but decided to save that for the next rev, as there's still some ambiguity about the best customer experience, and what's most feasible given conventional-changelog. related #15591
|
|
|
Sorry but I didn't understand the command. Please consult the commands documentation 📚. Hey, I reacted but my real name is @Mergifyio |
1 similar comment
|
Sorry but I didn't understand the command. Please consult the commands documentation 📚. Hey, I reacted but my real name is @Mergifyio |
skinny85
left a comment
There was a problem hiding this comment.
Looks great overall. I still think we shouldn't put the Changelog for the experimental modules inside the V1 module directory. If you feel really strongly on this topic, feel free to get a second opinion from someone else on the team, and if they also say the experimental Changelog should be in the V1 package directory, I'll acquiesce.
skinny85
left a comment
There was a problem hiding this comment.
One question about CHANGELOG.alpha.md.
|
@njlynch here's an idea: how about, instead of generating a separate alpha Changelog, you generate one Changelog for V2, but in the format that you proposed in the RFC, so looking like: # [v2.1.0]
---
## aws-cdk-lib
### Features
* **bar:** new fizzbuzz support ([#999999](https://github.com/aws/aws-cdk/issues/999999)) (b01dface), closes [#999998](https://github.com/aws/aws-cdk/issues/999998)
* **foo:** more buzzing on the fizzes ([#999994](https://github.com/aws/aws-cdk/issues/999999)) (deadb33f), closes [#999993](https://github.com/aws/aws-cdk/issues/999993)
### Bug Fixes
* **core:** transmorgrifier sometimes clones subject ([#999991](https://github.com/aws/aws-cdk/issues/15313)) (0ddba11), closes [#999990](https://github.com/aws/aws-cdk/issues/999990)
--
## Alpha Modules (v2.1.0-alpha.0)
### BREAKING CHANGES
* **newbar:** default answer to life, universe and everything changed from 41 to 42.
### Features
* **newbar:** add support for adding foos ([#999999](https://github.com/aws/aws-cdk/issues/999999)) (b01dface), closes [#999998](https://github.com/aws/aws-cdk/issues/999998)
### Bug Fixes
* **newbar:** answer to life has off-by-one error ([#999991](https://github.com/aws/aws-cdk/issues/15313)) (0ddba11), closes [#999990](https://github.com/aws/aws-cdk/issues/999990)My justification for this is that you will have to write the code to produce this format anyway (for the GitHub release). If that's the case, why not do it here, and put this logic in |
Because the scenarios are different. With the GitHub release, we have no choice but to combine everything together. With the in-source Changelog, we have the option of providing a "clean" Changelog that only shows the changes associated with Also, the level of indentation between both is different. The main Changelog has the version/release at an H2, whereas the GitHub release notes has it as an H1/title. That allows for better nesting without having to rewrite as much code. Finally, we actually don't know that the combined format is reasonable from an implementation perspective, and the agreement in the RFC was to try the combined format if it was simple enough, and otherwise link to the individual Changelogs. |
|
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). |
|
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 |
This is part of the continued work to release the experimental modules as independent alpha modules. This change introduces a new mode for handling changes in the changelog: in this new mode, all changes from alpha modules are still stripped from the main changelog (as they are currently for v2); those alpha module changes are now also written to a dedicated changelog (e.g., `CHANGELOG.v2.alpha.md`). related aws#15591 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
This is part of the continued work to release the experimental modules as independent alpha modules. This change introduces a new mode for handling changes in the changelog: in this new mode, all changes from alpha modules are still stripped from the main changelog (as they are currently for v2); those alpha module changes are now also written to a dedicated changelog (e.g., `CHANGELOG.v2.alpha.md`). related aws#15591 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
This is part of the continued work to release the experimental modules as
independent alpha modules. This change introduces a new mode for handling
changes in the changelog: in this new mode, all changes from alpha modules are still
stripped from the main changelog (as they are currently for v2); those alpha module
changes are now also written to a dedicated changelog (e.g.,
CHANGELOG.v2.alpha.md).related #15591
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license