Repository navigation
feat: reproducible scripted recordings in CI, with termshow check --json and a workflow recipe - #459
Merged
Merged
Conversation
📚 Preview this PR's docs locallyFetch the just-built site and open it in your browser: # this exact build
great-docs preview --run 40619421683
# or always the latest build for this PR
great-docs preview --pr 459Auth & tips
|
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.
This PR makes the shell that runs a script's steps start with a clean environment: it passes through only a few variables, such as
PATH,HOMEandLANG, so editor and CI settings like VS Code'sPYTHONSTARTUPorNO_COLORno longer leak into recordings. This changes behaviour for existing scripts, and the newrecord.inherit_env: truesetting restores it.great-docs termshow check --jsonprints the results as one JSON object, with a summary and each script's status, diffs and errors, and keeps the same exit status. The user guide gains a "Keeping demos up to date in CI" section with a GitHub Actions workflow that checks demos on pull requests and opens a pull request with re-recorded demos on a schedule.