Skip to content

docs: migrate workflows example to @rivet-dev/workflows - #296

Open
jog1t wants to merge 1 commit into
mainfrom
docs/workflows-package-refs
Open

jog1t wants to merge 1 commit into
mainfrom
docs/workflows-package-refs

Conversation

@jog1t

@jog1t jog1t commented Sep 18, 2026

Copy link
Copy Markdown

Workflows moved out of rivetkit/workflow into the standalone @rivet-dev/workflows package. This updates the workflows example and its docs page to the new API.

Changes

  • examples/apps-workflows/fixtures/app/src/index.ts: actor({ run: workflow(async (wf) => ...) }) becomes workflow({ state, actions, run: async (wf) => ... }), with setup and workflow imported from @rivet-dev/workflows. Steps and behavior are unchanged.
  • examples/apps-workflows/fixtures/app/package.json: adds @rivet-dev/workflows@1.0.0. rivetkit@2.3.11 stays, because the builder uses it to detect an actor app and supplies the platform RivetKit, which satisfies the package's rivetkit >=2.3.11 <2.4.0 peer.
  • examples/apps-workflows/package.json and pnpm-lock.yaml: add @rivet-dev/workflows@1.0.0 so the fixture type-checks in the workspace.
  • examples/apps-workflows/README.md: describes the order actor (charge, ship, sleep, deliver) instead of a "keyed job actor", and fixes the URL to /apps/order-workflow/ to match the order-workflow app ID used by client.ts.
  • docs/content/docs/workflows.mdx: names @rivet-dev/workflows and links to the Workflows docs.

No other rivetkit/workflow imports, run: workflow( usages, or "RivetKit workflow" prose remain in docs/ or examples/.

Verification

  • pnpm build && pnpm check-types: passes.
  • pnpm --filter @rivet-dev/dynamic-apps-example-workflows check-types: passes.
  • pnpm biome check examples/apps-workflows docs: clean.
  • Local deploy (POST /deploy/order-workflow): the build installs, bundles, and validates the fixture with @rivet-dev/workflows. It then fails at the tar pack step with Operation not permitted (os error 63) on macOS. origin/main fails the same way, so this is environmental and not caused by this change.

@railway-app

railway-app Bot commented Sep 18, 2026

Copy link
Copy Markdown

🚅 Environment dynamic-apps-pr-296 in rivet-frontend has no services deployed.


🚅 Deployed to the dynamic-apps-pr-296 environment in secure-exec

Service Status Web Updated
secure-exec ❌ Build Failed (View Logs) Web Sep 18, 2026 at 1:43 am UTC

@the-company-company the-company-company Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

No issues found

Reviewed commit 6dc31a9.

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.

1 participant