ComPWA / update-pre-commit

Composite GitHub Action to auto-update .pre-commit-config.yaml

Auto-update pre-commit GitHub Action

A small custom, composite GitHub Action that is used by ComPWA repositories that pin constraints files (see update-pip-constraints). The action is enforced in these repositories through ComPWA/repo-maintenance.

Example workflow

jobs:
  pre-commit:
    name: pre-commit autoupdate
    runs-on: ubuntu-22.04
    steps:
      - uses: actions/checkout@v2
        with:
          fetch-depth: 0
      - name: Check if there are changes to pre-commit config
        run: git diff origin/main --exit-code -- .pre-commit-config.yml
        continue-on-error: true
      - name: Update hooks in pre-commit config
        if: success()
        uses: ComPWA/update-pre-commit@main

  push:
    name: Push changes
    runs-on: ubuntu-22.04
    needs:
      - pre-commit
    steps:
      - uses: actions/checkout@v4
        with:
          token: ${{ secrets.PAT }}
        # GITHUB_TOKEN will not rerun checks after pushing to a PR branch
      - uses: actions/download-artifact@v4
        with:
          path: pre-commit
      - run: |
          [[ -f .pre-commit-config.yaml ]] && mv -f .pre-commit-config.yaml ..
        working-directory: pre-commit
      - name: Commit and push changes
        run: |
          git remote set-url origin https://x-access-token:${{ secrets.PAT }}@github.com/${{ github.repository }}
          git config --global user.name "GitHub"
          git config --global user.email "[e-mail]"
          git checkout -b ${GITHUB_HEAD_REF}
          if [[ $(git status -s) ]]; then
            git add -A
            git commit -m "ci: upgrade pinned requirements (automatic)"
            git config pull.rebase true
            git pull origin ${GITHUB_HEAD_REF}
            git push origin HEAD:${GITHUB_HEAD_REF}
          fi