Repository navigation
Generate the deterministic recipe-wrangle runtime contract manifest - #1199
Draft
mborodii-prog wants to merge 7 commits into
Draft
mborodii-prog wants to merge 7 commits into
mborodii-prog wants to merge 7 commits into
Conversation
mborodii-prog
force-pushed
the
generate-and-publish-a-versioned-runtime-manifest-for-every-WranglesPY-release
branch
from
October 8, 2026 13:18
887a887 to
c2aaa4a
Compare
16 of 40 tasks
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.
Related to #1195.
Adds a versioned runtime manifest
Changes
Discover stock recipe operations from the actual runtime namespace, including nested operations, executable aliases, and reserved recipe names.
Export signatures, public and internal parameters, defaults, embedded schemas, and supported recipe controls.
Record the package version and full source commit SHA.
Validate the generated manifest against the version
0.1JSON Schema.Generate a SHA-256 checksum alongside the manifest.
Preserve the original
--outputoption and default output filename.Update runtime-manifest documentation and release instructions.
Tagged exports verify that the selected tag, package version, and checkout commit agree. Uncommitted runtime or exporter changes are rejected unless explicitly generating a local preview.
Catalog identity support
Adds
wrangles.utils.catalog_identityto attach an already allocated catalog ID to a callable.The exporter preserves this ID as a decimal string, validates PostgreSQL BIGINT bounds, and rejects duplicate identities. Functions without an annotation are exported without
catalog_id.This PR does not allocate IDs or add annotations to existing operations.
Local examples
Install the required dependencies:
Generate a validated manifest from committed source:
Generate a development preview containing uncommitted changes:
Output:
Workflow integration
Both
ci.ymlandpublish-tagged.ymlrun the focused tests, generate the manifest, and upload:schema: recipe schema, legacy manifest filename, and manifest validation schema.runtime-manifest: manifest JSON and SHA-256 checksum.CI produces preview artifacts. Successful stable tagged-release runs provide the version-specific runtime contract.
For this same-repository feature PR only, the temporary preview sync waits for schema validation and build, verifies the artifact checksum, then commits and pushes the two runtime manifest files directly to Wrangles-Docs
main. It skips unchanged files and never force-pushes. It does not create a Docs PR or request Pull requests permissions. This writes a source PR preview to Docs main before the WranglesPY PR is merged. The GitHub App needs Contents write and authorization under Docs main branch rules; the workflow does not alter protection. Remove the temporary job or agree on a permanent trigger after the delivery test.Automatic download, Registry content updates, and import into Wrangles-Docs remain part of wrangleworks/Wrangles-Docs#35. DEV/RC exports and GitHub Release assets are outside this change.
Validation
34 focused tests passed after rebasing onto current main:
python -m pytest -c pytest-local.ini tests/test_wrangle_runtime_manifest.py -q. The pinned Docs lookup contract explicitly expects the current deprecation description; the historical fixture remains unchanged and every other field is still compared exactly.Both workflows passed
actionlint.Tag verification passed with shallow checkouts for lightweight and annotated tags.
Updated direct-push workflow passed YAML parsing and actionlint v1.7.12 (ShellCheck unavailable locally).
Previous preview sync failed with GH013 on its protected target branch; end-to-end direct publishing to Docs main remains to be verified by the new CI run. The extra Pull requests token permission that caused HTTP 422 has been removed.