Merge branch 'main' into update-prost

Author: CleanCut

.github/workflows/ci.yml

@@ -17,7 +17,7 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
     - name: Install protoc
       run: script/install-protoc
     - name: Build
@@ -28,7 +28,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
     - name: Install protoc
       run: script/install-protoc
     - name: Lint

.github/workflows/create-release-pr.yml

@@ -1,3 +1,6 @@
+# Launch this workflow with the "Run workflow" button in the Actions tab of the repository.
+#
+# See https://github.com/github/twirp-rs/blob/main/CONTRIBUTING.md#releasing for more details.
 name: Create release PR
 
 permissions:
@@ -20,7 +23,7 @@ jobs:
       cancel-in-progress: false
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           fetch-depth: 0
       - name: Install Rust toolchain

.github/workflows/publish-release.yml

@@ -1,4 +1,7 @@
-name: Release and unpublished twirp/twirp-build packages
+# This workflow only publishes releases for PR's created by create-release-pr.yml
+#
+# See https://github.com/github/twirp-rs/blob/main/CONTRIBUTING.md#releasing for more details.
+name: Release any unpublished twirp/twirp-build packages
 
 permissions:
   contents: write
@@ -17,7 +20,7 @@ jobs:
       contents: write
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           fetch-depth: 0
       - name: Install Rust toolchain

Cargo.lock

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.9.0](https://github.com/github/twirp-rs/compare/twirp-build-v0.8.0...twirp-build-v0.9.0) - 2025-07-31
+
+- See [the changelog for twirp](https://github.com/github/twirp-rs/blob/main/crates/twirp/CHANGELOG.md) for this release.

crates/twirp-build/CHANGELOG.md

@@ -1,6 +1,6 @@
 [package]
 name = "twirp-build"
-version = "0.11.0"
+version = "0.9.0"
 edition = "2021"
 description = "Code generation for async-compatible Twirp RPC interfaces."
 readme = "README.md"

crates/twirp-build/Cargo.toml

@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
 use quote::{format_ident, quote};
 
 /// Generates twirp services for protobuf rpc service definitions.

crates/twirp-build/src/lib.rs

@@ -0,0 +1,60 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.9.1](https://github.com/github/twirp-rs/compare/twirp-v0.9.0...twirp-v0.9.1) - 2025-08-14
+
+### Fixed
+
+- Preserve HTTP version in twirp client response ([#235](https://github.com/github/twirp-rs/pull/235))
+
+### Other
+
+- Bump tokio from 1.46.1 to 1.47.1 ([#231](https://github.com/github/twirp-rs/pull/231))
+
+## [0.9.0](https://github.com/github/twirp-rs/compare/twirp-build-v0.8.0...twirp-build-v0.9.0) - 2025-07-31
+
+### Breaking
+
+- Remove `SERVICE_FQN` to avoid upgrade confusion ([#222](https://github.com/github/twirp-rs/pull/222))
+
+#### Breaking: Allow custom headers and extensions for twirp clients and servers; unify traits; unify error type ([#212](https://github.com/github/twirp-rs/pull/212))
+
+- No more `Context`. The same capabilities now exist via http request and response [Extensions](https://docs.rs/http/latest/http/struct.Extensions.html) and [Headers](https://docs.rs/http/latest/http/header/struct.HeaderMap.html).
+- Clients and servers now share a single trait (the rpc interface).
+- It is possible to set custom headers on requests (client side) and it's possible for server handlers to read request headers and set custom response headers.
+- The same ☝🏻 is true for extensions to allow interactivity with middleware.
+- All the above is accomplished by using `http::request::Request<In>` and `http::response::Response<Out>` where `In` and `Out` are the individual rpc message types.
+- We have unifyied and simplified the error types. There is now just `TwirpErrorResponse` which models the [twirp error response spec](https://twitchtv.github.io/twirp/docs/spec_v7.html#error-codes).
+
+
+#### Breaking: Generate service fqn ([#221](https://github.com/github/twirp-rs/pull/221))
+
+Applications will need to remove any manual service nesting they are doing today.
+
+In 0.8.0, server consumers of this library have to know how to properly construct the fully qualified service path by using `nest` on an `axum` `Router` like so:
+
+```rust
+let twirp_routes = Router::new()
+        .nest(haberdash::SERVICE_FQN, haberdash::router(api_impl));
+```
+
+This is unnecessary in 0.9.0 (the generated `router` function for each service does that for you). Instead, you would write:
+
+``` rust
+let twirp_routes = haberdash::router(api_impl);
+```
+
+It is still canonical (but not required) to then nest with a `/twirp` prefix (the examples show this).
+
+### Other
+
+- Allow mocking out requests ([#220](https://github.com/github/twirp-rs/pull/220))
+- Swap twirp and twirp-build readmes. Replace the repo readme with a symlink to twirp's readme. ([#215](https://github.com/github/twirp-rs/pull/215))
+- Update the content of the readme ([#216](https://github.com/github/twirp-rs/pull/216))
+- Include the readme in rustdoc ([#225](https://github.com/github/twirp-rs/pull/225))

crates/twirp/CHANGELOG.md

@@ -1,6 +1,6 @@
 [package]
 name = "twirp"
-version = "0.11.0"
+version = "0.9.1"
 edition = "2021"
 description = "An async-compatible library for Twirp RPC in Rust."
 readme = "README.md"
@@ -29,6 +29,6 @@ reqwest = { version = "0.12", default-features = false }
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 thiserror = "2.0"
-tokio = { version = "1.46", default-features = false }
+tokio = { version = "1.47", default-features = false }
 tower = { version = "0.5", default-features = false }
 url = { version = "2.5" }

crates/twirp/Cargo.toml

@@ -1,4 +1,4 @@
-# `twirp-build`
+# `twirp`
 
 [Twirp is an RPC protocol](https://twitchtv.github.io/twirp/docs/spec_v7.html) based on HTTP and Protocol Buffers (proto). The protocol uses HTTP URLs to specify the RPC endpoints, and sends/receives proto messages as HTTP request/response bodies. Services are defined in a [.proto file](https://developers.google.com/protocol-buffers/docs/proto3), allowing easy implementation of RPC services with auto-generated clients and servers in different languages.
 
@@ -34,7 +34,11 @@ prost-build = "0.13"
 
 Add a `build.rs` file to your project to compile the protos and generate Rust code:
 
-```rust
+<!--
+`rust` gets syntax highlighting in GitHub UI and Rustdoc contexts
+` ,ignore` (including the space) makes rust tests ignore the code without breaking syntax highlighting
+-->
+```rust ,ignore
 fn main() {
     let proto_source_files = ["./service.proto"];
 
@@ -55,7 +59,11 @@ This generates code that you can find in `target/build/your-project-*/out/exampl
 
 Include the generated code, create a router, register your service, and then serve those routes in the hyper server:
 
-```rust
+<!--
+`rust` gets syntax highlighting in GitHub UI and Rustdoc contexts
+` ,ignore` (including the space) makes rust tests ignore the code without breaking syntax highlighting
+-->
+```rust ,ignore
 mod haberdash {
     include!(concat!(env!("OUT_DIR"), "/service.haberdash.v1.rs"));
 }
@@ -93,7 +101,11 @@ This code creates an `axum::Router`, then hands it off to `axum::serve()` to han
 
 On the client side, you also get a generated twirp client (based on the rpc endpoints in your proto). Include the generated code, create a client, and start making rpc calls:
 
-``` rust
+<!--
+`rust` gets syntax highlighting in GitHub UI and Rustdoc contexts
+` ,ignore` (including the space) makes rust tests ignore the code without breaking syntax highlighting
+-->
+```rust ,ignore
 mod haberdash {
     include!(concat!(env!("OUT_DIR"), "/service.haberdash.v1.rs"));
 }