Use tag-based Splice snippet extraction#650
Draft
danielporterda wants to merge 1 commit into
Draft
Conversation
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
2 participants
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
Switches the Splice external snippet config from line-number ranges to stable string-marker tags. This removes the brittle dependency on exact source line numbers in
config/snippet-config/splice-snippet-list-remote.json.The helper now strips marker lines cleanly when markers appear on source-comment lines, and the RST snippet transform handles
code,code-block, andparsed-literaldirectives while preserving legacy snippet indentation.Dependency
Depends on the upstream source tags from canton-network/splice#5732. Keep this PR draft until that PR lands or the source ref used for generation includes those tags.
Validation
direnv exec /Users/danielporter/control/.worktrees/cf-docs-splice-snippet-tags npm run generate:external-snippets -- splice --source-dir /Users/danielporter/control/.worktrees/splice-snippet-tags-source --skip-prepare --copy-output --version main --replace-output --min-free-gb 1152 succeeded, 0 faileddirenv exec /Users/danielporter/control/.worktrees/cf-docs-splice-snippet-tags bash -lc 'jq empty config/snippet-config/splice-snippet-list-remote.json && node --check scripts/generateOutputDocs.js'\n-git diff --check\n\nNo checked-in generated snippet files changed.