Skip to content

Commit 5eecdd6

Browse files
rinceyuanZhangyi YuanSteveSandersonMSCopilot
authored
docs(rust): point dependency examples at the published 1.0 line (#2520)
* docs(rust): point dependency examples at the published 1.0 line The crate has been on crates.io since 1.0.0 (2026-06-02) and is currently 1.0.11 stable, but the README still pinned `version = "0.1"` and carried a caveat saying the crate was not published yet. 0.1.0 (2026-05-06) predates the feature rename, so it exposes `embedded-cli` rather than `bundled-cli` / `bundled-in-process`. Copying the README's own feature examples therefore fails to resolve: error: failed to select a version for `github-copilot-sdk` The bare pin does resolve, but silently to the four-month-old 0.1.0. With `version = "1.0"` the same examples resolve to 1.0.11. * docs(rust): use compatible major version requirements Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Zhangyi Yuan <j-zhangyiyuan@microsoft.com> Co-authored-by: Steve Sanderson <SteveSandersonMS@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent f7eb2b0 commit 5eecdd6

1 file changed

Lines changed: 6 additions & 9 deletions

File tree

rust/README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -964,7 +964,7 @@ Enable `bundled-in-process` to additionally embed the native runtime library
964964
and use `Transport::InProcess`:
965965

966966
```toml
967-
github-copilot-sdk = { version = "0.1", features = ["bundled-in-process"] }
967+
github-copilot-sdk = { version = "1", features = ["bundled-in-process"] }
968968
```
969969

970970
`CliProgram::Path` and raw `ClientOptions::extra_args` apply only to
@@ -974,7 +974,7 @@ provisioned compatible runtime package with in-process transport.
974974
For builds that prefer a smaller artifact, disable the `bundled-cli` feature:
975975

976976
```toml
977-
github-copilot-sdk = { version = "0.1", default-features = false }
977+
github-copilot-sdk = { version = "1", default-features = false }
978978
```
979979

980980
> **You become responsible for supplying the runtime at deployment.** With
@@ -1112,20 +1112,17 @@ Supported: `darwin-arm64`, `darwin-x64`, `linux-x64`, `linux-arm64`, `win32-x64`
11121112
| `derive` || `schema_for::<T>()` for generating JSON Schema from Rust types (adds `schemars`). |
11131113

11141114
```toml
1115-
# These examples use registry syntax for illustration; until the crate is
1116-
# published, use a path or git dependency instead.
1117-
11181115
# Default — bundles the Copilot CLI in your binary.
1119-
github-copilot-sdk = "0.1"
1116+
github-copilot-sdk = "1"
11201117

11211118
# Enable the in-process transport and bundle its native runtime library.
1122-
github-copilot-sdk = { version = "0.1", features = ["bundled-in-process"] }
1119+
github-copilot-sdk = { version = "1", features = ["bundled-in-process"] }
11231120

11241121
# Opt out of bundling — supply the CLI explicitly at runtime.
1125-
github-copilot-sdk = { version = "0.1", default-features = false }
1122+
github-copilot-sdk = { version = "1", default-features = false }
11261123

11271124
# Derive JSON Schema for tool parameters (adds to default bundled-cli).
1128-
github-copilot-sdk = { version = "0.1", features = ["derive"] }
1125+
github-copilot-sdk = { version = "1", features = ["derive"] }
11291126
```
11301127

11311128
## Development

0 commit comments

Comments
 (0)