Update-Pre-Commit

😎 Why you need update-pre-commit?

If you are already using pre-commit or you are planning to use pre-commit to enforce coding standard and detect issues before code check-in, update-pre-commit keeps revs in .pre-commit-config.yaml up to date and facilitate your change management operations to optionally create pull request.

⭐ Why switch to update-pre-commit?

• we outperform others in update speed by more than 70%.
• we protect you against unreliable revs with tag such as alpha, beta, prerelease, and rc.
• we reduce your supply chain risks with openssf best practices in our development and operations.

🎉 Use Case 1️⃣ - running on GitHub action

Example - summary

update-pre-commit:

• runs on a scheduled interval - every day at 5:30 pm UTC (- cron: '30 17 * * *')
• uses GitHub Token with permissions: contents: write and pull-requests: write
• updates .pre-commit-config.yaml when new revs become available (dry-run: false)
• opens a pull request after update to .pre-commit-config.yaml (open-pr: true)

Example - workflow

name: update-pre-commit

on:
  # on schedule: e.g. every day at 5:30 pm UTC
  schedule:
    - cron: '30 17 * * *'

  # on demand
  workflow_dispatch:

permissions:
  contents: read
  pull-requests: read

jobs:
  update-pre-commit:
    runs-on: ubuntu-latest
    permissions:
      contents: write
      pull-requests: write

    steps:
    - name: Run update-pre-commit
      id: update-pre-commit
      env:
        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      uses: tagdots/update-pre-commit@<commit sha> # 1.3.0
      with:
        file: .pre-commit-config.yaml
        dry-run: false
        open-pr: true

🎉 Use Case 2️⃣ - running CLI locally

Prerequisites

* Python (3.12+)
  □ install pre-commit.

* GitHub
  □ create a fine-grained token with repository permissions (see below).

🔆 Install update-pre-commit

In the command-line examples below, we use a GitHub project named hello-world. This project has pre-commit installed and a valid .pre-commit-config.yaml.

We will first install update-pre-commit in a virtual environment named after the project. Next, we will run update-pre-commit with different options and show the results.

~/work/hello-world $ export GH_TOKEN=github_pat_xxxxxxxxxxxxx
~/work/hello-world $ uv pip install -U update-pre-commit

🔍 Using update-pre-commit

🏃 Run to show command line usage and options: --help

(hello-world) ~/work/hello-world $ update-pre-commit --help

Usage: update-pre-commit [OPTIONS]

Options:
  --file TEXT        default: .pre-commit-config.yaml
  --dry-run BOOLEAN  default: true
  --open-pr BOOLEAN  default: false
  --version          Show the version and exit.
  --help             Show this message and exit.

🏃 Run default (without any options)

By default, update-pre-commit implicitly runs --dry-run true --open-pr false.

update-pre-commit:

1. reads .pre-commit-config.yaml.
2. produces a list of out-of-date pre-commit hooks on screen.
   (NO changes will be made to .pre-commit-config.yaml)

(hello-world) ~/work/hello-world $ update-pre-commit

Starting update-pre-commit (ver.: 1.3.0, file: .pre-commit-config.yaml, dry-run True, open-pr False)...

hadolint/hadolint (v2.11.0) is not using the latest release rev (v2.12.0)
pycqa/flake8 (7.1.2) is not using the latest release tag (7.2.0)
antonbabenko/pre-commit-terraform (v1.98.0) is not using the latest release rev (v1.98.1)

✅ Update revs in .pre-commit-config.yaml: None

🏃 Run to update out-of-date hooks: --dry-run false

update-pre-commit:

1. reads .pre-commit-config.yaml.
2. produce a list of out-of-date pre-commit hooks.
3. update .pre-commit-config.yaml.

(hello-world) ~/work/hello-world $ update-pre-commit --dry-run false

Starting update-pre-commit (ver.: 1.3.0, file: .pre-commit-config.yaml, dry-run False, open-pr False)...

hadolint/hadolint (v2.11.0) is not using the latest release rev (v2.12.0)
pycqa/flake8 (7.1.2) is not using the latest release tag (7.2.0)
antonbabenko/pre-commit-terraform (v1.98.0) is not using the latest release rev (v1.98.1)

✅ Update revs in .pre-commit-config.yaml: Success

🏃 Run to update out-of-date hooks and open a pull request: --dry-run false --open-pr true

update-pre-commit:

1. reads .pre-commit-config.yaml.
2. produces a list of out-of-date pre-commit hooks on screen.
3. updates .pre-commit-config.yaml.
4. checkout a new git branch update_pre_commit_XXXXXXXXXXXXXXXXXXXXX.
5. opens a pull request against repository default branch.

(hello-world) ~/work/hello-world $ update-pre-commit --dry-run false --open-pr true

Starting update-pre-commit (ver.: 1.3.0, file: .pre-commit-config.yaml, dry-run False, open-pr True)...

hadolint/hadolint (v2.11.0) is not using the latest release rev (v2.12.0)
pycqa/flake8 (7.1.2) is not using the latest release tag (7.2.0)
antonbabenko/pre-commit-terraform (v1.98.0) is not using the latest release rev (v1.99.0)

✅ Update revs in .pre-commit-config.yaml: Success
✅ Checkout new branch (dep/update_pre_commit_01M38D6RHRMWPS2EBHB4NWX0P1).
✅ Push commits to remote from local branch: dep/update_pre_commit_01M38D6RHRMWPS2EBHB4NWX0P1
✅ Pull request created successfully : https://github.com/tagdots/update-pre-commit/pull/709
✅ Branch restored to original branch: main

😕 Troubleshooting

Step 1 - Ensure the following

* your project's .pre-commit-config.yaml file is valid.
* your GitHub fine-grained token has the write permissions to contents and pull requests.
* update-pre-commit can find the .pre-commit-config.yaml file at the root of YOUR project.

Step 2 - Open an issue

🙏 Contributing

Pull requests and stars are always welcome. For pull requests to be accepted on this project, you should follow PEP8 when creating/updating Python codes.

See Contributing

📚 References

Pre-Commit on Github

How to fork a repo

Manage Github Token