Fix external snippet helper copy#718
Draft
danielporterda wants to merge 1 commit into
Draft
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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
1 participant
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
generate:external-snippetsaftergenerateOutputDocs.jsmoved underscripts/helpersrstIncludeToMdx.jsbeside the helper in source repos so the helper can resolve its local require--copy-outputto write todocs-main/snippets/external/...sv-values.yamlmigration snippet/import because latest Splice main no longer has theMIGRATION_STARTmarkerRoot cause
PR #662 deleted the root-level
scripts/generateOutputDocs.js, butscripts/generate_external_snippets.pystill expected that path and copied only one helper file. Current helper code lives underscripts/helpers/and requires./rstIncludeToMdx, so the wrapper had to copy both files together.Validation
PYTHONPATH=/tmp/cf-docs-pytest python3 -m pytest tests/test_generate_external_snippets.py tests/test_network_variable_tabs.pyPYTHONDONTWRITEBYTECODE=1 python3 scripts/validate_network_variable_tabs.pyjq empty config/snippet-config/splice-snippet-list-remote.json docs-main/docs.jsonpython3 -m py_compile scripts/generate_external_snippets.py scripts/generate_network_variable_tabs.py tests/test_generate_external_snippets.pynode --check scripts/helpers/generateOutputDocs.jsnode --check scripts/helpers/rstIncludeToMdx.js/snippetsimport scangit diff --checkorigin/mainworktree:165 succeeded, 0 failedFollow-up
A broad
--replace-outputSplice snippet refresh still exposes stale line-number snippets insv_helm.rst; those should be converted to stable markers or rebaselined before committing broad generated snippet drift.