Add a workflow for external contributors to add a changelog entry #2944
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
lucix-aws
reviewed
Jan 6, 2025
| @@ -484,6 +484,14 @@ set-smithy-go-version: | |||
| fi | |||
| go run ${REPOTOOLS_CMD_EDIT_MODULE_DEPENDENCY} -s "github.com/aws/smithy-go" -v "${SMITHY_GO_VERSION}" | |||
|
|
|||
| external-changelog: | |||
| mkdir -p .changelog | |||
| cp changelog-template.json .changelog/00000000-0000-0000-0000-000000000000.json | |||
There was a problem hiding this comment.
I know you said x-platform concerns in the desc but I'm also fine with just calling uuid -v4 and letting people figure it out / do it manually otherwise.
lucix-aws
approved these changes
Jan 6, 2025
wty-Bryant
approved these changes
Jan 6, 2025
| { | ||
| "id": "00000000-0000-0000-0000-000000000000", | ||
| "type": "feature|bugfix|dependency", | ||
| "description": "Description of your changes", |
There was a problem hiding this comment.
do we need collapse here
There was a problem hiding this comment.
The doc mentions it, don't think we need it here, but also a default of false would be fine.
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.
Add instructions on how external contributors can add a
.changelogentry. We've been taking over adding them in the past, but it'd be nice if contributors can do it themselves.The workflow now would be
make external-changelog.changelog/xxx.jsonthat they would need to modifyWhy
external-changelog?Because we internally use aws-go-multi-module-repository-tools. External contributors could use it too, but it's a bit too cumbersome to set it up for using only single time
Why not creating a uuid on behalf of contributors?
There's no built-in uuid tool that would work cross-platform