Skip to content

docs: add Node and Bun process worker deployment guide#630

Open
jumski wants to merge 1 commit into
portable-worker-bun-smokefrom
portable-worker-docs
Open

docs: add Node and Bun process worker deployment guide#630
jumski wants to merge 1 commit into
portable-worker-bun-smokefrom
portable-worker-docs

Conversation

@jumski

@jumski jumski commented Jun 7, 2026

Copy link
Copy Markdown
Contributor

Adds documentation and navigation for deploying pgflow workers as long-running Node or Bun processes on hosts like Railway, Fly, Docker, or VMs.

The new guide covers installing the npm package, writing a worker script, required environment variables (DATABASE_URL, SUPABASE_URL, SUPABASE_SERVICE_ROLE_KEY), running the worker under Node or Bun, graceful shutdown behavior on SIGTERM/SIGINT/SIGQUIT, health monitoring via database queries, and how process workers differ from HTTP-started workers in that ensure_workers() does not restart them.

The deploy overview page and sidebar navigation are updated to include the new guide, the Supabase deployment page gains a callout pointing process-hosted deployments to the new guide, and the edge-worker README replaces its JSR-only warning with a note that the package is published to both JSR and npm with guidance on which to use for each runtime.

jumski commented Jun 7, 2026

Copy link
Copy Markdown
Contributor Author

@nx-cloud

nx-cloud Bot commented Jun 7, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 34377ec

Command Status Duration Result
nx run edge-worker:test:integration ✅ Succeeded 4m 27s View ↗
nx run client:e2e ✅ Succeeded 1m 15s View ↗
nx run edge-worker:e2e ✅ Succeeded 1m 1s View ↗
nx affected -t verify-exports --base=origin/mai... ✅ Succeeded 3s View ↗
nx run cli:e2e ✅ Succeeded 3s View ↗
nx affected -t build --configuration=production... ✅ Succeeded 3s View ↗
nx affected -t lint typecheck test --parallel -... ✅ Succeeded 22s View ↗
nx run core:pgtap ✅ Succeeded <1s View ↗
nx run edge-worker:smoke:bun ✅ Succeeded 5s View ↗

💡 Verify your cache is correct by running tasks in a sandbox. Read docs ↗


☁️ Nx Cloud last updated this comment at 2026-06-08 19:30:02 UTC

@jumski jumski force-pushed the portable-worker-bun-smoke branch from 5d91440 to ab81d38 Compare June 8, 2026 17:50
@jumski jumski force-pushed the portable-worker-docs branch from e05006e to 475fe79 Compare June 8, 2026 17:50
@changeset-bot

changeset-bot Bot commented Jun 8, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 34377ec

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

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

Click here to learn what changesets are, and how to add one.

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

@changeset-bot

changeset-bot Bot commented Jun 8, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 475fe79

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

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

Click here to learn what changesets are, and how to add one.

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

@jumski jumski force-pushed the portable-worker-docs branch from 475fe79 to e27f093 Compare June 8, 2026 18:08
@jumski jumski force-pushed the portable-worker-bun-smoke branch from ab81d38 to 6ac3f60 Compare June 8, 2026 18:08
@jumski jumski force-pushed the portable-worker-docs branch from e27f093 to eae2d01 Compare June 8, 2026 18:24
@jumski jumski force-pushed the portable-worker-bun-smoke branch from 6ac3f60 to 34cbcd8 Compare June 8, 2026 18:24
@jumski jumski force-pushed the portable-worker-docs branch from eae2d01 to 34377ec Compare June 8, 2026 19:22
@jumski jumski deployed to preview June 8, 2026 19:30 — with GitHub Actions Active
@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

🔍 Preview Deployment: Website

Deployment successful!

🔗 Preview URL: https://pr-630.pgflow.pages.dev

📝 Details:

  • Branch: portable-worker-docs
  • Commit: 46e6d49b6100b56159680396189e0c4b99ac6774
  • View Logs

_Last updated: _

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