Pre commit hooks

pre-commit hook used to...

Check if the copyright is up to date (using the Git history).

Adding to your .pre-commit-config.yaml

ci:
  skip:
    # Skip the copyright check on pre-commit.ci because we don't have the Git history
    - copyright
    - copyright-required
    # Poetry didn't works with Python 3.11
    - poetry-lock
    - poetry-check

repos:
  - repo: https://github.com/sbrunner/hooks
    rev: <version> # Use the ref you want to point at
    hooks:
      # Check that the copyright is up to date
      - id: copyright
      # Check that the copyright is present and up to date
      - id: copyright-required
      # Require a timeout in GitHub workflow files
      - id: workflows-require-timeout
      # Check Poetry config
      - id: poetry-check
        additional_dependencies:
          - poetry==<version>
      # Do Poetry lock
      - id: poetry-lock
        additional_dependencies:
          - poetry==<version>
      # Do Pipfile lock
      - id: pipenv-lock
        additional_dependencies:
          - pipenv==<version>
      # Do uv lock, from the pyproject.toml file to the uv.lock file
      - id: uv-lock
        additional_dependencies:
          - uv==<version>
      # Export the PEP 751 lock file, from the uv.lock file to the pylock.toml file
      - id: uv-pylock
        additional_dependencies:
          - uv==<version>
      # Do Helm lock (helm should be installed)
      - id: helm-lock
      - id: npm-lock

uv

The uv-lock hook runs uv lock in the folder of the pyproject.toml file and generates the uv.lock file, the native uv lock format.

The uv-pylock hook runs uv export --format=pylock.toml --output-file=pylock.toml in the folder of the uv.lock file and generates the pylock.toml file, the PEP 751 lock format.

As with the other lock hooks, the hooks modify the files and pre-commit fails: in the continuous integration the change is uploaded as the Apply pre-commit fix.patch artifact and applied by the patch module of ghci, so a dependency bump of the .in file regenerates the .txt file automatically.

Copyright configuration

The default values used in the .github/copyright.yaml file.

Default values:

one_date_re: ' Copyright \\(c\\) (?P<year>[0-9]{4})"))'
two_date_re: ' Copyright \\(c\\) (?P<from>[0-9]{4})-(?P<to>[0-9]{4})")'
one_date_format: ' Copyright (c) {year}")'
two_date_format: ' Copyright (c) {from}-{to}")'
license_file: LICENSE

one_date_re: ' Copyright \(c\) (?P<year>[0-9]{4})'
two_date_re: ' Copyright \(c\) (?P<from>[0-9]{4})-(?P<to>[0-9]{4})'
one_date_format: ' Copyright (c) {year}'
two_date_format: ' Copyright (c) {from}-{to}'
license_file: LICENSE