Skip to content

Commit 712d40f

Browse files
committed
docs: add README "Releasing" section for parity with Go client
Add a "Releasing" subsection to the Rust README "Versioning" section documenting the crates.io distribution mechanism and the manually-triggered rust-publish.yml workflow, so the Rust and Go sibling clients no longer diverge on release documentation. Record the change in CHANGELOG [0.2.2].
1 parent 8528b6e commit 712d40f

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ No changes to the public interface; packaging metadata and a release workflow on
3131
- Documentation: removed dangling reference-style Markdown link brackets around
3232
`apify_client::models` (`docs/README.md`) and `futures_util::StreamExt` (`docs/misc.md`) so
3333
they render as plain inline code rather than broken links on GitHub.
34+
- Documentation: added a "Releasing" subsection to the README "Versioning" section describing the
35+
crates.io distribution mechanism and the publish workflow, for parity with the Go sibling.
3436

3537
## [0.2.1] - 2026-06-19
3638

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,16 @@ println!("client {CLIENT_VERSION}, built against API spec {API_SPEC_VERSION}");
113113
- `CLIENT_VERSION` — semantic version of this crate.
114114
- `API_SPEC_VERSION` — the Apify OpenAPI spec version this client targets.
115115

116+
### Releasing
117+
118+
The crate is distributed on [crates.io](https://crates.io/crates/apify-client). The
119+
[`Publish Rust client to crates.io`](.github/workflows/rust-publish.yml) workflow is the release
120+
mechanism: a maintainer triggers it manually (`workflow_dispatch`), it runs the same
121+
fmt/clippy/build quality gate as CI, verifies packaging with `cargo publish --dry-run`, then runs
122+
`cargo publish`. The registry token is read only from the `CARGO_REGISTRY_TOKEN` repository secret,
123+
and a `dry_run` input allows a packaging-only run with no actual release. Bump `version` in
124+
`Cargo.toml` before releasing.
125+
116126
## Examples
117127

118128
Runnable examples live in [`examples/`](examples). Each requires `APIFY_TOKEN` and can be

0 commit comments

Comments
 (0)