Skip to content

Support indented code blocks (fixes #11) #162

Support indented code blocks (fixes #11)

Support indented code blocks (fixes #11) #162

name: Update README.md
on:
push:
branches:
- main
pull_request:
jobs:
update_readme:
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v6
with:
persist-credentials: false
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: "3.14.2"
- name: Install uv
uses: astral-sh/setup-uv@v7
- name: Install markdown-code-runner
run: |
uv venv
uv pip install .
# Install dependencies you're using in your README.md
- name: Install other Python dependencies
run: |
uv pip install pandas tabulate pytest matplotlib requests
# Rust is only needed for an example in our README.md
- uses: actions-rust-lang/setup-rust-toolchain@v1
- name: Run update-readme.py
run: uv run markdown-code-runner --verbose README.md
- name: Commit updated README.md
id: commit
run: |
git add README.md
git config --local user.email "github-actions[bot]@users.noreply.github.com"
git config --local user.name "github-actions[bot]"
if git diff --quiet && git diff --staged --quiet; then
echo "No changes in README.md, skipping commit."
echo "commit_status=skipped" >> $GITHUB_ENV
else
git commit -m "Update README.md"
echo "commit_status=committed" >> $GITHUB_ENV
fi
- name: Push changes
if: env.commit_status == 'committed'
uses: ad-m/github-push-action@master
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
branch: ${{ github.head_ref }}