Unverified Commit 10a92052 authored by ysaito1001's avatar ysaito1001 Committed by GitHub
Browse files

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](https://github.com/smithy-lang/smithy-rs/pull/3774/commits/83cda766089f8d47401d3693f21791e34c770595)
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](https://github.com/smithy-lang/smithy-rs/pull/3774/commits/efcc772b37940c9e0f676e6eedac134ae5ad044e)
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._
parent 63753f3f

.changelog/.example

0 → 100644
+10 −0
Original line number Diff line number Diff line 
# 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

.changelog/.keep

deleted100644 → 0
+0 −0

Empty file deleted.

.changelog/1722464864.md

0 → 100644
+14 −0
Original line number Diff line number Diff line 
---

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.

.changelog/1722464947.md

0 → 100644
+12 −0
Original line number Diff line number Diff line 
---

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.

.github/PULL_REQUEST_TEMPLATE.md

+2 −2
Original line number Diff line number Diff line
@@ -12,8 +12,8 @@ 


## Checklist

<!--- If a checkbox below is not applicable, then please DELETE it rather than leaving it unchecked -->

- [ ] I have updated `CHANGELOG.next.toml` if I made changes to the smithy-rs codegen or runtime crates

- [ ] I have updated `CHANGELOG.next.toml` if I made changes to the AWS SDK, generated SDK code, or SDK runtime crates

- [ ] For changes to the smithy-rs codegen or runtime crates, I have created a changelog entry Markdown file in the `.changelog` directory, specifying "client," "server," or both in the `applies_to` key.

- [ ] For changes to the AWS SDK, generated SDK code, or SDK runtime crates, I have created a changelog entry Markdown file in the `.changelog` directory, specifying "aws-sdk-rust" in the `applies_to` key.



----