pre-commit-update 0.0.3

Simple CLI tool to check and update pre-commit hooks.

pre-commit-update

pre-commit-update is a simple CLI tool to check and update pre-commit hooks.

Table of contents

1. Reasoning
2. Installation
3. Usage
   1. Pipeline usage example
   2. pre-commit hook usage example

1. Reasoning

pre-commit is a nice little tool that helps you polish your code before releasing it into the wild. It is fairly easy to use. A single pre-commit-config.yaml file can hold multiple hooks (checks) that will go through your code or repository and do certain checks. The trick is that file is static and once you pin your hook versions after a while they get outdated.

pre-commit has a CLI that helps with that by making use of pre-commit autoupdate command so the question is why the f* are you reading this?

pre-commit-update was created mostly because there is no easy way to update your hooks by using pre-commit autoupdate and avoiding non-stable (alpha, beta, ...) hook versions. pre-commit-update comes with a CLI that can be configured to solve that problem - along with other use cases.

Other than that - I was bored ^^

2. Installation

pre-commit-update is available on PyPI:

$ python -m pip install pre-commit-update

Python >= 3.7 is supported.

3. Usage

pre-commit-update currently supports github.com and gitlab.com repositories.

pre-commit-update CLI can be used as below:

Usage: pre-commit-update [OPTIONS]

Options:
  -d, --dry-run       Dry run only checks for new versions
  -a, --all-versions  Include alpha/beta versions
  -v, --verbose       Display complete output
  --help              Show this message and exit.

If you want to just check for updates (without updating pre-commit-config.yaml), for example, you would use:

pre-commit-update -d
OR
pre-commit-update --dry-run

Pipeline usage example

GitLab job:

pre-commit-hooks-update:
  stage: update
  script:
    - pip install pre-commit-update
    - pre-commit-update --dry-run
  except:
    - main
  when: manual
  allow_failure: true

NOTE: This is just an example, feel free to do your own configuration

pre-commit hook usage example

You can also use pre-commit-update as a hook in your pre-commit hooks:

  - repo: local
    hooks:
      - id: pre-commit-update
        entry: pre-commit-update
        language: python
        name: pre-commit-update
        pass_filenames: false
        args: [--dry-run]