Skip to content

docs(shim-protos): fix stale README commands#476

Merged
mxpv merged 1 commit into
containerd:mainfrom
immanuwell:docs/shim-protos-readme-fixes
Jun 20, 2026
Merged

docs(shim-protos): fix stale README commands#476
mxpv merged 1 commit into
containerd:mainfrom
immanuwell:docs/shim-protos-readme-fixes

Conversation

@immanuwell

Copy link
Copy Markdown
Contributor

README has a few stale shim-protos bits, so following it from repo root goes sideways a bit.

Fixes:

  • use the real crate name containerd-shim-protos
  • drop the non-existent generate_bindings feature
  • point example commands at the actual built example path
  • bump the README version snippet to 0.11

How to repro:

  1. Run cargo +stable build -p containerd-shim-protos --features generate_bindings
    It fails because that feature does not exist
  2. Run cargo +stable info containerd-shim-client
    It fails because that crate is not published
  3. Follow ./shim-proto-connect ...
    That path is a miss, the binary is under target/debug/examples/

Checked:

  • cargo +stable build -p containerd-shim-protos --example shim-proto-connect
  • cargo +stable build -p containerd-shim-protos --example shim-proto-connect-async --features async

@github-actions github-actions Bot added T-docs Improvements or additions to documentation C-shim-protos Shim protos labels Jun 20, 2026
@mxpv mxpv added this pull request to the merge queue Jun 20, 2026
Merged via the queue into containerd:main with commit 22bc8ce Jun 20, 2026
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

C-shim-protos Shim protos T-docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants