feat: add standalone "Test examples" CI step and complete documentation coverage - #3
Merged
Merged
Conversation
Align the client with the updated client requirements: - CI: add a standalone `Test examples` step that actually runs the documentation example code end-to-end (`cargo test --test examples`, each example program executed against the live API) plus the in-documentation doctests (`cargo test --doc`). `Run integration tests` now skips the example smoke tests so they run only in the dedicated step. - Docs: wire every docs/ page containing code into doctests via `#[doc = include_str!]` so all in-documentation snippets are compiled and checked (doctests 7 -> 21). - Docs: document response-model fields read by the README quick start and examples (ActorRun, Actor, Build, User, storage metadata, RequestQueueRequest, ActorStoreListItem, PaginationList and friends) and surface all copy-paste dependencies (serde_json, futures-util) in the install sections. - Bump version to 0.2.1 and record the change in CHANGELOG.md.
github-actions
Bot
added
t-tooling
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Brings the Rust client into compliance with the updated client requirements (documentation/examples). This is a CI/docs compliance change only — the client is already at OpenAPI spec
v2-2026-06-18T095846Zand there is no spec bump and no public-interface change.Changes
Test examplesCI step —.github/workflows/rust-integration-tests.ymlnow has a step named exactlyTest examplesthat actually runs the documentation example code:cargo test --test examplesexecutes each of the 7 example programs end-to-end against the live API (viacargo run --example <name>), followed bycargo test --docfor the in-documentation snippets.Run integration testsnow skips the example smoke tests (--skip example_) so the examples run only in the dedicated step, and the old doctests-only step was folded intoTest examples.docs/page containing code is wired into doctests via#[doc = include_str!](previously only the root README was doctest-checked). Doctests went from 7 to 21.ActorRun,Actor,Build,User, storage-metadata.idfields,RequestQueueRequest,ActorStoreListItem,PaginationList,RequestQueueHead/OperationInfo,KeyValueStoreKeysPage), and surfaced every copy-paste dependency (serde_json,futures-util) and import in the installation sections.0.2.0→0.2.1and recorded the change inCHANGELOG.md.Verification
cargo fmt --all -- --checkandcargo clippy --all-targets -- -D warningsclean.cargo test --doc— 21 doctests pass.cargo test --lib --tests -- --skip example_— unit/integration tests pass.Test examplesstep: all 7 example programs run end-to-end against the live API and pass.Generated by Claude Code