Skip to content

Commit 7380237

Browse files
committed
docs: add a 0.8.0 release post and update README.md (#390)
1 parent 43dd1a7 commit 7380237

13 files changed

+157
-24
lines changed
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
'@pgflow/core': minor
3+
'@pgflow/client': minor
4+
'@pgflow/edge-worker': minor
5+
'@pgflow/website': minor
6+
---
7+
8+
BREAKING CHANGE: pgflow 0.8.0 requires pgmq 1.5.0+, PostgreSQL 17, and Supabase CLI 2.34.3+
9+
10+
This version modernizes infrastructure dependencies and will NOT work with pgmq 1.4.x or earlier. The migration includes a compatibility check that aborts with a clear error message if requirements are not met.
11+
12+
**Requirements:**
13+
- pgmq 1.5.0 or higher (previously supported 1.4.x)
14+
- PostgreSQL 17 (from 15)
15+
- Supabase CLI 2.34.3 or higher (includes pgmq 1.5.0+)
16+
17+
**For Supabase users:** Upgrade your Supabase CLI to 2.34.3+ which includes pgmq 1.5.0 by default.
18+
19+
**For self-hosted users:** Upgrade pgmq to 1.5.0+ and PostgreSQL to 17 before upgrading pgflow.
20+
21+
**If you cannot upgrade immediately:** Stay on pgflow 0.7.x until your infrastructure is ready. The migration safety check ensures you cannot accidentally upgrade to an incompatible version.

.changeset/pgmq-version-bump.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

.changeset/upgrade-postgres-seventeen-supabase.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

pkgs/cli/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This package provides essential tools for setting up, managing, and deploying pg
1515

1616
## Prerequisites
1717

18-
- Supabase CLI v2.0.2 or higher
18+
- Supabase CLI v2.34.3 or higher
1919
- Deno v1.45.x or higher (for flow compilation)
2020
- Local Supabase project initialized
2121

pkgs/core/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,17 @@ This package focuses on:
4747

4848
The actual execution of workflow tasks is handled by the [Edge Worker](../edge-worker/README.md), which calls back to the SQL Core to acknowledge task completion or failure.
4949

50+
## Requirements
51+
52+
> [!IMPORTANT]
53+
> **pgmq Version Requirement** (since v0.8.0)
54+
>
55+
> pgflow v0.8.0 and later requires **pgmq 1.5.0 or higher**. This version of pgflow will NOT work with pgmq 1.4.x or earlier.
56+
>
57+
> - **Supabase Cloud**: Recent versions include pgmq 1.5.0+ by default
58+
> - **Self-hosted**: You must upgrade pgmq to version 1.5.0+ before upgrading pgflow
59+
> - **Version Check**: Run `SELECT extversion FROM pg_extension WHERE extname = 'pgmq';` to verify your pgmq version
60+
5061
## Key Features
5162

5263
- **Declarative Workflows**: Define flows and steps via SQL tables

pkgs/core/project.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@
5050
"options": {
5151
"cwd": "{projectRoot}",
5252
"commands": [
53+
"../../scripts/supabase-start-locked.sh .",
5354
"mkdir -p .nx-inputs",
5455
"scripts/atlas-verify-schemas-synced > .nx-inputs/verify-schemas-synced.txt 2>&1 || (cat .nx-inputs/verify-schemas-synced.txt && exit 1)"
5556
],

pkgs/core/supabase/migrations/20251104080523_pgflow_upgrade_pgmq_1_5_1.sql

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
-- Migration tested 2025-11-02:
2-
-- Successfully verified that this migration fails on pgmq 1.4.4 (Supabase CLI 2.0.2)
2+
-- Successfully verified that this migration fails on pgmq 1.4.4 (Supabase CLI < 2.34.3)
33
-- with clear error message guiding users to upgrade pgmq to 1.5.0+
44
--
55
-- Compatibility check: Ensure pgmq.message_record has headers column (pgmq 1.5.0+)

pkgs/core/supabase/migrations/atlas.sum

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
h1:SeEHqz8uDIqu6Px6f1IajB3NfXOYmetcSxFbp9PiYXY=
1+
h1:GRevz5BG7qrdQxFbQ0XO9f21I5qaYocLc08bN3gVG50=
22
20250429164909_pgflow_initial.sql h1:I3n/tQIg5Q5nLg7RDoU3BzqHvFVjmumQxVNbXTPG15s=
33
20250517072017_pgflow_fix_poll_for_tasks_to_use_separate_statement_for_polling.sql h1:wTuXuwMxVniCr3ONCpodpVWJcHktoQZIbqMZ3sUHKMY=
44
20250609105135_pgflow_add_start_tasks_and_started_status.sql h1:ggGanW4Wyt8Kv6TWjnZ00/qVb3sm+/eFVDjGfT8qyPg=
@@ -10,4 +10,4 @@ h1:SeEHqz8uDIqu6Px6f1IajB3NfXOYmetcSxFbp9PiYXY=
1010
20250719205006_pgflow_worker_deprecation.sql h1:pL5cR1/Oag993yWN6sUpE/U3LmVSzAlnoRXJRBtErU8=
1111
20251006073122_pgflow_add_map_step_type.sql h1:D/skgKpaVg5TM8bPovo9FUutQfg35/AzkxEcasYwytY=
1212
20251103222045_pgflow_fix_broadcast_order_and_timestamp_handling.sql h1:K/XnZpOmxfelsaNoJbR5HxhBrs/oW4aYja222h5cps4=
13-
20251104080523_pgflow_upgrade_pgmq_1_5_1.sql h1:xnbHNJkMGWoaIL5RH617CCjM9nX1Yde8TimHpHhk7fM=
13+
20251104080523_pgflow_upgrade_pgmq_1_5_1.sql h1:t+Hu/rqP8b23S+JAjJ86Y8UlOTCfA+085/8RxD7gydA=
1.7 MB
Loading

pkgs/website/src/content/docs/get-started/installation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import { FileTree } from '@astrojs/starlight/components';
1313
Let's set up pgflow in your Supabase project. This setup needs to be done only once per project.
1414

1515
<Aside type="caution" title="Prerequisites">
16-
- Supabase CLI version **2.0.2** or higher (check with `supabase -v`)
16+
- Supabase CLI version **2.34.3** or higher (check with `supabase -v`)
1717
- A local Supabase project set up
1818
- [Deno version **1.45.2 or higher**](https://github.com/denoland/deno/releases/tag/v1.45.2) (2.x also supported) - required for flow compilation
1919

0 commit comments

Comments
 (0)