-
Notifications
You must be signed in to change notification settings - Fork 193
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Switch to file-per-change changelog (#3774)
## Motivation and Context Implements [RFC: File-per-change changelog](https://smithy-lang.github.io/smithy-rs/design/rfcs/rfc0042_file_per_change_changelog.html#rfc-file-per-change-changelog) ## Description When this PR is merged to `main`, it will impact developer workflow for creating a changelog entry that goes with a PR. Prior to this, one edited `CHANGELOG.next.toml` to enter a changelog entry, but it often caused merge conflicts among us. With this PR, one creates a `.md` file (any filename stem will do) under the `smithy-rs/.changelog` directory. This Markdown file has the YAML front matter, and it can be created manually or via the `ChangeLogger` CLI (see [this commit](83cda76) for more details). Here are the highlights of the code changes: - [The release script](https://github.com/smithy-lang/smithy-rs/pull/3774/files#diff-162dc2b82eb3d72b105291d2fc5fc8d10c4fbc1e6f35862bc08ac0d6a7c53f76) has been pointed to `smithy-rs/.changelog`. This is pretty much what it takes to let the `smithy-rs` release infra switch to the new changelog mode. - [sdk-lints](efcc772) now disallows `CHANGELOG.next.toml`. It will complain if the file is present. - The `--source-to-truncate` option for the `changelogger`'s `render` is now optional because our internal release infra code no longer needs to specify that option (i.e. there is nothing to truncate there). - Tests in `smithy-rs-tool-common` and `changelogger` have been updated so TOML changelog entries used in tests have been re-written to Markdown changelog entries. We want to avoid giving the false impression that TOML changelog entries are still well-supported. ## Testing - Existing tests & lints in CI - Ran `smithy-rs` [dry-run release](https://github.com/smithy-lang/smithy-rs/actions/runs/10100442953) and confirmed the correctness of `CHANGELOG.md` and `SDK_CHANGELOG.next.json` in the release artifacts - Ran the internal release and confirmed `CHANGELOG.md` was rendered correctly in `aws-sdk-rust` ---- _By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice._
- Loading branch information
1 parent
63753f3
commit 10a9205
Showing
23 changed files
with
841 additions
and
900 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Example changelog entry, Markdown with YAML front matter | ||
# --- | ||
# applies_to: ["client", "server", "aws-sdk-rust"] # "aws-sdk-rust" here duplicates this entry into release notes in `aws-sdk-rust` | ||
# authors: ["rcoh"] | ||
# references: ["smithy-rs#920"] | ||
# breaking: false | ||
# new_feature: false | ||
# bug_fix: false | ||
# --- | ||
# Fix typos in module documentation for generated crates |
Empty file.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
applies_to: | ||
- aws-sdk-rust | ||
- client | ||
authors: | ||
- landonxjames | ||
references: | ||
- smithy-rs#3765 | ||
- smithy-rs#3757 | ||
breaking: false | ||
new_feature: false | ||
bug_fix: true | ||
--- | ||
Fix incorrect redaction of `@sensitive` types in maps and lists. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
applies_to: | ||
- client | ||
authors: | ||
- ysaito1001 | ||
references: | ||
- smithy-rs#3767 | ||
breaking: false | ||
new_feature: false | ||
bug_fix: true | ||
--- | ||
Fix client error correction to properly parse structure members that target a `Union` containing that structure recursively. |
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
This file was deleted.
Oops, something went wrong.
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
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
Oops, something went wrong.