Skip to content

docs: expand Python workflow guide - #3923

Merged
fantix merged 3 commits into
mainfrom
fantix/python-docs
Sep 2, 2026
Merged

docs: expand Python workflow guide#3923
fantix merged 3 commits into
mainfrom
fantix/python-docs

Conversation

@fantix

@fantix fantix commented Sep 1, 2026

Copy link
Copy Markdown
Member

Summary

  • install the standalone vercel-workflow package in the Python guide
  • document starting workflows and inspecting Run handles
  • add a minimal workflow streaming example
  • fix Python code-line highlighting with the current Shiki notation

Testing

  • git diff --check
  • pnpm --dir docs build

Docs Preview

Version Preview
v5 Python guide
v4 Python guide

@changeset-bot

changeset-bot Bot commented Sep 1, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: adb20bb

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@vercel

vercel Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

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

Project Deployment Actions Updated
example-nextjs-workflow-turbopack Ready Ready Preview, v0 Sep 1, 2026 5:20pm UTC
example-nextjs-workflow-webpack Ready Ready Preview, v0 Sep 1, 2026 5:20pm UTC
example-workflow Ready Ready Preview, v0 Sep 1, 2026 5:20pm UTC
workbench-astro-workflow Ready Ready Preview, v0 Sep 1, 2026 5:20pm UTC
workbench-express-workflow Ready Ready Preview, v0 Sep 1, 2026 5:20pm UTC
workbench-fastify-workflow Ready Ready Preview, v0 Sep 1, 2026 5:20pm UTC
workbench-hono-workflow Ready Ready Preview, v0 Sep 1, 2026 5:20pm UTC
workbench-nestjs-workflow Ready Ready Preview, v0 Sep 1, 2026 5:20pm UTC
workbench-nitro-workflow Ready Ready Preview, v0 Sep 1, 2026 5:20pm UTC
workbench-nuxt-workflow Ready Ready Preview, v0 Sep 1, 2026 5:20pm UTC
workbench-python-workflow Ready Ready Preview, v0 Sep 1, 2026 5:20pm UTC
workbench-sveltekit-workflow Ready Ready Preview, v0 Sep 1, 2026 5:20pm UTC
workbench-tanstack-start-workflow Ready Ready Preview, v0 Sep 1, 2026 5:20pm UTC
workbench-vite-workflow Ready Ready Preview, v0 Sep 1, 2026 5:20pm UTC
workflow-docs Ready Ready Preview, v0 Sep 1, 2026 5:20pm UTC
workflow-swc-playground Ready Ready Preview, v0 Sep 1, 2026 5:20pm UTC
workflow-tarballs Ready Ready Preview, v0 Sep 1, 2026 5:20pm UTC
workflow-web Ready Ready Preview, v0 Sep 1, 2026 5:20pm UTC

@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Sim World

Simulated world deterministic testing for races. Traces

🟠 world-sim scenario book — 1 fail of 41 total

fence=per-spec

scenario outcome events virt replay violations
smoke-no-steps completed 3 0ms ok 0
smoke-one-step completed 6 0ms ok 0
hook-at-step-started completed 12 0ms ok 0
hook-at-step-completed completed 12 0ms ok 0
hook-at-hook-created completed 12 0ms ok 0
deadline-hook-wins completed 7 1.0h ok 0
deadline-expires completed 7 1.0h ok 0
long-sleep completed 11 30.0d ok 0
hook-never-arrives stalled 3 0ms skipped 0
step-retries-twice completed 10 2.0s ok 0
parallel-steps completed 9 0ms ok 0
hook-on-execution-state completed 12 0ms ok 0
peek-hook-before-branch completed 12 0ms ok 0
peek-hook-after-branch completed 12 0ms ok 0
peek-hook-at-registration completed 12 0ms ok 0
race-hook-before-probe completed 12 0ms ok 0
race-hook-after-probe completed 12 0ms ok 0
race-duplicate-delivery completed 13 0ms ok 0
attr-hook-before-step completed 11 0ms ok 0
attr-hook-after-step completed 11 0ms ok 0
attr-from-step-body completed 13 0ms ok 0
fork-hook-after-timeout completed 14 1.0m ok 0
fork-hook-before-timeout completed 14 1.0m ok 0
count-hook-after-timeout completed 17 1.0m ok 0
count-hook-before-timeout completed 20 1.0m ok 0
stale-read-step-count-fork completed 20 1.0m ok 0
stale-read-equal-step-counts completed 14 1.0m ok 0
step-vs-step-fork completed 12 0ms ok 0
step-vs-step-fork-fenced completed 12 0ms ok 0
fence-catches-benign-direction completed 12 5ms ok 0
in-flight-before-decision completed 17 1.0m ok 0
in-flight-before-decision-counted completed 17 1.0m ok 0
in-flight-after-decision completed 19 2.0m ok 0
stale-read-step-count-fork-fenced completed 20 1.0m ok 0
fork-hook-wins completed 13 1.0m ok 0
fork-timeout-wins completed 13 1.0m ok 0
unclaimed-payload-under-fork completed 17 1.0m ok 0
claimed-payload-under-fork completed 17 1.0m ok 0
writers-independent-step-bodies completed 12 0ms ok 0
writers-scripted-tempo completed 12 0ms ok 0
cancel-mid-step cancelled 7 0ms skipped 0

Full trace: world-sim.txt

@fantix
fantix enabled auto-merge (squash) September 2, 2026 23:32
@fantix
fantix merged commit aba7c8d into main Sep 2, 2026
65 checks passed
@fantix
fantix deleted the fantix/python-docs branch September 2, 2026 23:41
@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

No backport to stable for aba7c8d (AI decision).

The commit is primarily a docs expansion — it adds new "Starting a workflow" and "Streaming" sections documenting additional Python SDK capabilities, which is documentation of new capabilities rather than a correction. It also does not apply to stable: verified with git ls-tree origin/stable that neither docs/content/docs/v4/getting-started/python.mdx nor the v5 path exists there (stable has no Python guide at all, and no versioned getting-started trees). The genuine corrections bundled in (the vercelvercel-workflow package name and the Shiki highlight notation) have no target on stable.

To override, re-run the Backport to stable workflow manually via workflow_dispatch and paste this commit SHA into the ref input:

aba7c8d5d0df39ae857219d5f1802711aeaa6a1a

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