[codex] Add external snippet provenance comments#609
Draft
danielporterda wants to merge 2 commits into
Draft
Conversation
2d0d1ee to
05ee0c1
Compare
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.
What changed
Adds a searchable
source-snippetHTML comment to generated external snippet MDX files. The comment records the source repo, source path, source commit hash, snippet name, and extraction location.The generator keeps import-leading MDX valid by placing the provenance comment after the import block when a generated snippet starts with
importstatements.This refresh also updates the wrapper copy target to the current checked-in tree under
docs-main/snippets/external, documents that location in the update workflow, and adds provenance comments to existing checked-in snippet files that still map cleanly to current extraction config.Why
This creates a stable text-search join between generated snippet files and the source repository state that produced them, which is the first step toward auditing orphaned or stale external snippets.
Refresh and run status
mainat25425b81c5c7d7948a14dd7d02faeb381235f8ec.cn-quickstart,daml-shell,scribe,splice, andwallet-gateway.canton,daml, anddpm; those failures happen before a trustworthy full corpus copy can be made.Validation
direnv exec . node --check scripts/generateOutputDocs.jsdirenv exec . node --check scripts/helpers/generateOutputDocs.jsdirenv exec . python3 -m py_compile scripts/generate_external_snippets.pydirenv exec . npm run generate:external-snippets -- --listgit diff --check