Skip to content

docs(rust): point dependency examples at the published 1.0 line - #2520

Merged
SteveSandersonMS merged 2 commits into
github:mainfrom
rinceyuan:docs/rust-readme-published-version
Sep 4, 2026
Merged

docs(rust): point dependency examples at the published 1.0 line#2520
SteveSandersonMS merged 2 commits into
github:mainfrom
rinceyuan:docs/rust-readme-published-version

Conversation

@rinceyuan

Copy link
Copy Markdown
Contributor

Summary

rust/README.md still pins version = "0.1" in every dependency example and says the crate is not published yet. It has been on crates.io since 1.0.0 (2026-06-02); the current stable is 1.0.11.

0.1.0 was published 2026-05-06 and predates the feature rename, so it exposes embedded-cli rather than bundled-cli / bundled-in-process. Copying the README's own feature examples fails outright:

$ cargo generate-lockfile     # github-copilot-sdk = { version = "0.1", features = ["bundled-in-process"] }
error: failed to select a version for `github-copilot-sdk`.

The bare github-copilot-sdk = "0.1" does resolve, but silently to the four-month-old 0.1.0, which is a pre-1.0 API.

This updates the six examples to "1.0" and drops the stale pre-publication caveat.

Verification

Real resolution, not cargo add --dry-run (which reports features "as of v1.0.0" and rejects bundled-in-process for that reason even when the requirement is satisfiable):

Dependency line cargo generate-lockfile
{ version = "0.1", features = ["bundled-in-process"] } fails to select a version
"0.1" resolves to 0.1.0
{ version = "1.0", features = ["bundled-in-process"] } resolves to 1.0.11, 214 packages locked

Feature sets from the crates.io API confirm the cause:

  • 0.1.0 - default, derive, embedded-cli, test-support
  • 1.0.11 - bundled-cli, bundled-in-process, default, derive, test-support

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.
Copilot AI balanced review requested due to automatic review settings September 4, 2026 07:34
@rinceyuan
rinceyuan requested a review from a team as a code owner September 4, 2026 07:34

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Warning

Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.

Pull request overview

Updates the Rust README dependency examples to target the published stable 1.0 crate line (instead of 0.1) and removes the outdated “not published yet” note so that documented feature examples resolve correctly on crates.io.

Changes:

  • Bump all github-copilot-sdk dependency examples from version = "0.1" / "0.1" to version = "1.0" / "1.0".
  • Remove the pre-publication caveat about needing path/git dependencies.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

@SteveSandersonMS SteveSandersonMS left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved after validating the crates.io resolution and updating the README requirements to the repository's documented compatible \1\ Cargo style.

@SteveSandersonMS
SteveSandersonMS added this pull request to the merge queue Sep 4, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Sep 4, 2026
@SteveSandersonMS
SteveSandersonMS added this pull request to the merge queue Sep 4, 2026
@SteveSandersonMS
SteveSandersonMS removed this pull request from the merge queue due to a manual request Sep 4, 2026
@SteveSandersonMS
SteveSandersonMS merged commit de75efa into github:main Sep 4, 2026
23 checks passed
@rinceyuan
rinceyuan deleted the docs/rust-readme-published-version branch September 7, 2026 01:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants