Skip to content

chore(rust): update docs to 1.0 - #5253

Open
chris-olszewski wants to merge 1 commit into
mainfrom
olszewski/rust_1_0
Open

chore(rust): update docs to 1.0#5253
chris-olszewski wants to merge 1 commit into
mainfrom
olszewski/rust_1_0

Conversation

@chris-olszewski

Copy link
Copy Markdown
Member

What does this PR do?

Update docs for Rust SDK 1.0.0. GA hasn't been announced (planned 9/8), but the crate has been released.

Notes to reviewers

Copilot AI balanced review requested due to automatic review settings September 4, 2026 19:58
@vercel

vercel Bot commented Sep 4, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
temporal-documentation Ready Ready Preview Sep 4, 2026 7:58pm UTC

Request Review

@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

📖 Docs PR preview links

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.

🟡 Changes recommended

Release-stage notices are removed before GA, and a duplicated Cloud Run example still uses pre-1.0 APIs.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Updates Rust SDK documentation and examples for version 1.0.0.

Changes:

  • Updates crate versions and renamed APIs.
  • Revises Worker versioning and Signal-With-Start examples.
  • Updates API links and feature guidance.
File summaries
File Description
docs/develop/rust/workflows/message-passing.mdx Updates Signal-With-Start usage.
docs/develop/rust/workflows/child-workflows.mdx Uses current API documentation links.
docs/develop/rust/workers/worker-process.mdx Updates dependencies and Worker APIs.
docs/develop/rust/workers/serverless-workers/cloud-run.mdx Migrates Cloud Run examples to 1.0 APIs.
docs/develop/rust/quickstart.mdx Updates dependencies and runtime initialization.
docs/develop/rust/nexus/feature-guide.mdx Notes the required experimental feature.
docs/develop/rust/client/temporal-client.mdx Updates runtime initialization.
docs/develop/rust/activities/timeouts.mdx Removes a pre-release qualification.
Review details

Suppressed comments (1)

docs/develop/rust/activities/timeouts.mdx:28

  • The PR description says GA has not yet been announced, but this removes the page's explicit pre-release status before the planned September 8 announcement. Retain the current warning until GA, or keep this update from publishing until then.
In Rust, these values are configured as part of the Activity options when scheduling an Activity from a Workflow.
  • Files reviewed: 8/8 changed files
  • Comments generated: 4
  • Review effort level: Balanced

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

An Activity Execution must have either the Start-To-Close Timeout or the Schedule-To-Close Timeout set. Temporal strongly recommends setting a Start-To-Close Timeout because the service relies on it to detect lost Activity Tasks and trigger retries when appropriate.

In Rust, these values are configured as part of the Activity options when scheduling an Activity from a Workflow. The Rust SDK is currently pre-release and its API is still evolving, so exact method names may change over time.
In Rust, these values are configured as part of the Activity options when scheduling an Activity from a Workflow.

The Rust SDK is in [Public Preview](/evaluate/development-production-features/release-stages#public-preview), and its API can change between releases.
The code on this page is written against `temporalio-sdk` 0.7.0.
The code on this page is written against `temporalio-sdk` 1.0.0.
let api_key = std::env::var("TEMPORAL_API_KEY")?;

let runtime = Runtime::new_assume_tokio(Default::default())?;
let runtime = Runtime::from_current_tokio(Default::default())?;

The Rust SDK is in [Public Preview](/evaluate/development-production-features/release-stages#public-preview), and its API can change between releases.
The code on this page is written against `temporalio-sdk` 0.7.0.
The code on this page is written against `temporalio-sdk` 1.0.0.
@chris-olszewski
chris-olszewski marked this pull request as ready for review September 4, 2026 20:20
@chris-olszewski
chris-olszewski requested a review from a team as a code owner September 4, 2026 20:20
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.

2 participants