Skip to content

docs(pgpm): document bundle envelope, applyEnvelope, and table-data export in package READMEs#1438

Merged
pyramation merged 1 commit into
mainfrom
feat/envelope-docs
Jul 23, 2026
Merged

docs(pgpm): document bundle envelope, applyEnvelope, and table-data export in package READMEs#1438
pyramation merged 1 commit into
mainfrom
feat/envelope-docs

Conversation

@pyramation

Copy link
Copy Markdown
Contributor

Summary

Human-facing README docs for the artifact structures landed in #1433/#1435/#1436 — previously only the pgpm-migration-bundle agent skill covered them:

  • pgpm/bundle/README.md: new "The bundle envelope" section — the shipping-container framing (schema + data + fixtures as one sealed, versioned, tamper-evident package), createEnvelope/verifyEnvelope example, manifest/Merkle-digest model, payload-agnostic parts, JSON + directory serialization layout.
  • pgpm/core/README.md: "Migration bundles and envelopes" section — applyBundle and applyEnvelope/previewEnvelopeApply semantics (digest gate, one-transaction part replay, layered rollback plan, transformPartSql ID-remap seam).
  • pgpm/export/README.md: feature entry for the generic table-data export (exportTablesData + deploy/revert/verify builders) and its role as the envelope's data/fixtures payload producer.

Docs-only; no code changes.

Link to Devin session: https://app.devin.ai/sessions/ad40d16f38a349b48eb7ce9375e27e6e
Requested by: @pyramation

@pyramation pyramation self-assigned this Jul 23, 2026
@devin-ai-integration

Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@pyramation
pyramation merged commit 4754b13 into main Jul 23, 2026
2 checks passed
@pyramation
pyramation deleted the feat/envelope-docs branch July 23, 2026 19:59
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