Add logo and simplify docs homepage #372
Workflow file for this run
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
| 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 | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v7 | |
| - name: Run markdown-code-runner | |
| run: uvx --with . markdown-code-runner 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' && github.event_name == 'pull_request' | |
| uses: ad-m/github-push-action@master | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| branch: ${{ github.head_ref }} | |
| - name: Fail if README is out of date on main | |
| if: env.commit_status == 'committed' && github.event_name == 'push' | |
| run: | | |
| echo "README.md is out of date. Please run 'uvx --with . markdown-code-runner README.md' and commit the changes." | |
| exit 1 |