docs(pgpm): document bundle envelope, applyEnvelope, and table-data export in package READMEs#1438
Merged
Merged
Conversation
…xport in package READMEs
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Human-facing README docs for the artifact structures landed in #1433/#1435/#1436 — previously only the
pgpm-migration-bundleagent 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/verifyEnvelopeexample, manifest/Merkle-digest model, payload-agnostic parts, JSON + directory serialization layout.pgpm/core/README.md: "Migration bundles and envelopes" section —applyBundleandapplyEnvelope/previewEnvelopeApplysemantics (digest gate, one-transaction part replay, layered rollback plan,transformPartSqlID-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