[PR #846] Add readme-ci – run README code blocks and fail CI when the quickstart breaks #15405

Open
opened 2026-07-18 17:32:18 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/sdras/awesome-actions/pull/846
Author: @ondraulehla
Created: 7/15/2026
Status: 🔄 Open

Base: mainHead: add-readme-ci


📝 Commits (1)

📊 Changes

1 file changed (+1 additions, -0 deletions)

View changed files

📝 README.md (+1 -0)

📄 Description

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.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/sdras/awesome-actions/pull/846 **Author:** [@ondraulehla](https://github.com/ondraulehla) **Created:** 7/15/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `add-readme-ci` --- ### 📝 Commits (1) - [`df2205d`](https://github.com/sdras/awesome-actions/commit/df2205db7cc9c180e99892744cd55591186dc19c) Add readme-ci to Testing ### 📊 Changes **1 file changed** (+1 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+1 -0) </details> ### 📄 Description ## What is this action? [readme-ci](https://github.com/ondraulehla/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. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-07-18 17:32:18 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/awesome-actions#15405