docs: add crate changelogs - #321
Open
Tim-Zhang wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds reconstructed, dated changelogs for the ttrpc, ttrpc-compiler, and ttrpc-codegen crates, and updates the release checklist to require adding changelog entries as part of each release. This improves upgrade/migration discoverability without changing any Rust code.
Changes:
- Added full historical
CHANGELOG.mdfiles forttrpc,ttrpc-compiler, andttrpc-codegen, including API change notes and yanked-release annotations. - Added migration guidance at minor release boundaries where API behavior changes.
- Updated
RELEASE.mdto require adding a dated changelog section and fixed/clarified release-step wording.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
CHANGELOG.md |
Adds the ttrpc crate’s full release history with API-change and migration notes. |
compiler/CHANGELOG.md |
Adds the ttrpc-compiler crate’s full release history with yanked-release annotations and API notes. |
ttrpc-codegen/CHANGELOG.md |
Adds the ttrpc-codegen crate’s full release history with API notes and upgrade guidance. |
RELEASE.md |
Updates the release checklist to require dated changelog entries and clarifies publishing steps. |
Suppressed comments (1)
RELEASE.md:28
- This sentence introduces an ordered sub-list; ending it with a colon improves readability and matches common Markdown style.
5. If the dry run succeeds, publish the crates that need publishing using `cargo publish -p <crate>` in the following order
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Document published releases and notable API changes. Signed-off-by: Tim Zhang <tim@hyper.sh>
Tim-Zhang
force-pushed
the
docs/add-changelogs
branch
from
August 10, 2026 13:04
cc07e95 to
5820e2d
Compare
Tim-Zhang
marked this pull request as ready for review
August 10, 2026 13:14
This file contains hidden or 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
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.
Summary
ttrpc,ttrpc-compiler, andttrpc-codegenWhy
Users currently have to reconstruct compatibility and upgrade information
from Git history. These changelogs make notable changes, yanked releases,
and API migrations discoverable in one place.
This PR changes documentation only; it does not modify Rust code.
Validation
git diff --check