Add readme-ci – run README code blocks and fail CI when the quickstart breaks#846
Open
ondraulehla wants to merge 1 commit into
Open
Add readme-ci – run README code blocks and fail CI when the quickstart breaks#846ondraulehla wants to merge 1 commit into
ondraulehla wants to merge 1 commit into
Conversation
https://github.com/ondraulehla/readme-ci - a GitHub Action that executes the fenced code blocks in README/docs inside a sandbox and fails CI when a quickstart step breaks.
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.
What is this action?
readme-ci executes the fenced code blocks in your README/docs top-to-bottom in an isolated sandbox (throwaway Docker container or E2B cloud sandbox). Working directory and environment persist between blocks – exactly like a reader following the steps – and the first failing block fails CI, with the exact markdown line annotated on the run.
Added at the end of Static Analysis → Testing, per the contribution guidelines (single suggestion, one-line description, Title Casing).
Why it's useful
Quickstarts rot silently: a dependency bumps or a flag renames and the first thing every new user hits is broken, because docs are the one code path nobody executes. This action makes the README a tested artifact – and with
fix-pr: 'true'it can even open a pull request with an AI-repaired block, verified by re-running the file.