Add readme-ci to GitHub Actions#103
Open
ondraulehla wants to merge 1 commit into
Open
Conversation
https://github.com/ondraulehla/readme-ci - runs the 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.
Adds readme-ci to the GitHub Actions section (alphabetical position, matching the section's link style).
readme-ci executes the fenced code blocks in README/docs top-to-bottom in an isolated sandbox (Docker or E2B). State persists between blocks like a reader following along, and the first failing block fails CI with the exact markdown line annotated – so quickstarts can't rot silently. Optionally it can open a PR with an AI-repaired block, verified by re-running the file.
I'm the author and use it in CI on my own repositories.