Skip to content

Conversation

@jumski
Copy link
Contributor

@jumski jumski commented Nov 27, 2025

Update Flow Registration to Use Single File

This PR simplifies the pgflow architecture by consolidating flow registration into a single file. Instead of using a separate flows.ts file, flows are now registered directly in the index.ts file of the pgflow edge function.

Key changes:

  • Removed flows.ts and moved flow registration directly into index.ts
  • Updated error messages and documentation to reference index.ts instead of flows.ts
  • Added a new documentation page explaining the auto-compilation architecture
  • Updated the getting started guide to reflect the new registration pattern
  • Modified tests to match the new file structure

This change makes flow registration more straightforward for users and reduces the number of files they need to manage. The documentation now clearly explains how to register flows and how the auto-compilation process works.

@changeset-bot
Copy link

changeset-bot bot commented Nov 27, 2025

⚠️ No Changeset found

Latest commit: 4e4bae3

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

Copy link
Contributor Author

jumski commented Nov 27, 2025

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • merge:queue - adds this PR to the back of the merge queue
  • hotfix:queue - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@nx-cloud
Copy link

nx-cloud bot commented Nov 27, 2025

View your CI Pipeline Execution ↗ for commit 4e4bae3

Command Status Duration Result
nx affected -t verify-exports --base=origin/mai... ✅ Succeeded 3s View ↗
nx affected -t build --configuration=production... ✅ Succeeded 27s View ↗
nx affected -t lint typecheck test --parallel -... ✅ Succeeded 3m 38s View ↗
nx run edge-worker:e2e ✅ Succeeded 2m 52s View ↗
nx run cli:e2e ✅ Succeeded 5s View ↗

☁️ Nx Cloud last updated this comment at 2025-11-27 16:10:28 UTC

@jumski jumski force-pushed the 11-27-update_docs_for_auto-compilation_flow_and_remove_flows.ts branch from f5358e2 to df2a149 Compare November 27, 2025 14:16
npx pgflow@0.9.0 install
```

This creates the ControlPlane edge function at `supabase/functions/control-plane/`.
Copy link
Contributor

Choose a reason for hiding this comment

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

The documentation states the function is created at supabase/functions/control-plane/ but the actual path is supabase/functions/pgflow/ as shown throughout the rest of the PR. This will mislead users about where to find and modify the edge function.

- This creates the ControlPlane edge function at `supabase/functions/control-plane/`.
+ This creates the ControlPlane edge function at `supabase/functions/pgflow/`.
Suggested change
This creates the ControlPlane edge function at `supabase/functions/control-plane/`.
This creates the ControlPlane edge function at `supabase/functions/pgflow/`.

Spotted by Graphite Agent

Fix in Graphite


Is this helpful? React 👍 or 👎 to let us know.

@jumski jumski force-pushed the 11-27-update_docs_for_auto-compilation_flow_and_remove_flows.ts branch from df2a149 to 4e4bae3 Compare November 27, 2025 16:02
@github-actions
Copy link
Contributor

🔍 Preview Deployment: Website

Deployment successful!

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

📝 Details:

  • Branch: 11-27-update_docs_for_auto-compilation_flow_and_remove_flows.ts
  • Commit: e0adb914177974e6b9158b14f9faf196b8f0e405
  • View Logs

_Last updated: _

@graphite-app
Copy link
Contributor

graphite-app bot commented Nov 28, 2025

Merge activity

  • Nov 28, 11:45 PM UTC: jumski added this pull request to the Graphite merge queue.
  • Nov 28, 11:45 PM UTC: CI is running for this pull request on a draft pull request (#449) due to your merge queue CI optimization settings.
  • Nov 28, 11:53 PM UTC: Merged by the Graphite merge queue via draft PR: #449.

graphite-app bot pushed a commit that referenced this pull request Nov 28, 2025
…ts (#437)

# Update Flow Registration to Use Single File

This PR simplifies the pgflow architecture by consolidating flow registration into a single file. Instead of using a separate `flows.ts` file, flows are now registered directly in the `index.ts` file of the pgflow edge function.

Key changes:
- Removed `flows.ts` and moved flow registration directly into `index.ts`
- Updated error messages and documentation to reference `index.ts` instead of `flows.ts`
- Added a new documentation page explaining the auto-compilation architecture
- Updated the getting started guide to reflect the new registration pattern
- Modified tests to match the new file structure

This change makes flow registration more straightforward for users and reduces the number of files they need to manage. The documentation now clearly explains how to register flows and how the auto-compilation process works.
@graphite-app graphite-app bot closed this Nov 28, 2025
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