Skip to content

Update update_readme.yml #12

Update update_readme.yml

Update update_readme.yml #12

Workflow file for this run

name: Update README
on:
push:
branches:
- main
pull_request:
branches:
- main
jobs:
update-readme:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.x'
- name: Install uv
uses: astral-sh/setup-uv@v4
- name: "Set up Python"
uses: actions/setup-python@v5
with:
python-version-file: "pyproject.toml"
- name: Install the project
run: uv sync --all-extras --dev
- name: Update README
run: |
uv run docs/update_readme.py
- name: Check for changes
id: check_changes
run: |
if git diff --exit-code README.md > /dev/null; then
echo "no_changes=true" >> $GITHUB_ENV
else
echo "no_changes=false" >> $GITHUB_ENV
- name: Commit and push changes
if: env.no_changes == 'false'
run: |
git config --global user.name 'github-actions[bot]'
git config --global user.email 'github-actions[bot]@users.noreply.github.com'
git add README.md
git commit -m "Update README.md with function docstrings"
git push
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}