Skip to content

Document protoc-gen-connect-rust installation#40

Merged
iainmcgin merged 3 commits intomainfrom
iain/document-plugin-install
Apr 3, 2026
Merged

Document protoc-gen-connect-rust installation#40
iainmcgin merged 3 commits intomainfrom
iain/document-plugin-install

Conversation

@iainmcgin
Copy link
Copy Markdown
Collaborator

External users have hit issue #33 ("missing info on installation of protoc-gen-connect-rust"). The README references the binary in the buf.gen.yaml example but never tells you where to get it.

Adds an "Installing the plugins" subsection under Option A documenting three install paths:

  1. Download a pre-built binary from the GitHub release — with sha256sum -c, gh attestation verify, and cosign verify-blob verification commands. The cosign cert-identity URL is hardcoded to the release workflow path so users can copy-paste it.
  2. cargo install --locked connectrpc-codegen — pulls the published codegen crate from crates.io and installs protoc-gen-connect-rust into $CARGO_HOME/bin.
  3. BSR remote plugin (planned) — placeholder for the upstream-acceptance work in flight.

Also includes a one-line pointer to the buffa repo for protoc-gen-buffa and protoc-gen-buffa-packaging, which users on Option A also need.

Closes #33.

External users have asked where to get the protoc-gen-connect-rust
binary referenced in the buf.gen.yaml example. Add an 'Installing the
plugins' subsection under Option A covering three install paths:

- download a pre-built binary from the GitHub release (with sha256,
  cosign, and gh attestation verification commands)
- cargo install --locked connectrpc-codegen
- BSR remote plugin (planned, pending upstream acceptance)

Also points users at the buffa repo for protoc-gen-buffa and
protoc-gen-buffa-packaging.

Closes #33
@iainmcgin iainmcgin marked this pull request as ready for review April 2, 2026 20:50
@iainmcgin iainmcgin requested a review from asacamano April 2, 2026 20:50
@iainmcgin iainmcgin enabled auto-merge (squash) April 2, 2026 20:52
@iainmcgin iainmcgin merged commit 5f63954 into main Apr 3, 2026
11 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Apr 3, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: missing info on installation of protoc-gen-connect-rust

2 participants