Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,26 @@ packages/
* **One change per file** in each folder. If your deploy spans multiple SQL statements, they all live in that one file — see *revert mechanics* below.


## Generated artifacts (`sql/`)

`pgpm package` writes two committed artifacts per module, both derived from
`deploy/` + `pgpm.plan` and both **never hand-edited**:

```bash
pgpm package # sql/<name>--<version>.sql and sql/<name>--<version>.bundle.tar.gz
pgpm deploy --fast # deploy from the bundle: verify sha256, one-shot execute, write the ledger
```

The `.bundle.tar.gz` is a gzipped tarball of the module's JSON migration bundle
(plan + per-change SQL + sha256 digest); output is byte-reproducible, so
re-running `pgpm package` on unchanged sources produces no diff. `--fast` falls
back to building from `deploy/` when the artifact is missing or stale, so a
forgotten regeneration is a slowdown, not a failure — but regenerate both files
in the same commit as any `deploy/` change.

Requires the pgpm 5 CLI (`PGPM_VERSION` in the workflows); the pgpm 4 CLI
neither emits bundles nor honours `extensions.json`'s `schema`/`createSchema`.

## Physical mechanics

### Deploy
Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added packages/jobs/sql/pgpm-jobs--0.33.0.bundle.tar.gz
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added packages/totp/sql/pgpm-totp--0.33.0.bundle.tar.gz
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added packages/uuid/sql/pgpm-uuid--0.33.0.bundle.tar.gz
Binary file not shown.
Binary file not shown.
Loading