pre-commit in CI pipelines¶

Pre-commit can also be used for CI.

Examples for GitHub Actions¶

Service that adds the pre-commit ci app to your GitHub repository at https://github.com/PROFILE/REPOSITORY/installations.

Besides automatically changing pull requests, the app also autoupdate to keep your configuration up to date.

You can add further installations under Install pre-commit ci.

.github/workflows/pre-commit.yml

Alternative configuration as a GitHub workflow, for example:

name: pre-commit

on:
  pull_request:
  push:
    branches: [main]

jobs:
  pre-commit:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - uses: actions/setup-python@v3
    - uses: actions/cache@v3
      with:
        path: ~/.cache/pre-commit
        key: pre-commit|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml') }}
    - uses: pre-commit/action@v3.0.1

Example for GitLab Actions¶

stages:
  - validate

pre-commit:
  stage: validate
  image:
    name: python:3.12
  variables:
    PRE_COMMIT_HOME: ${CI_PROJECT_DIR}/.cache/pre-commit
  only:
    refs:
      - merge_requests
      - tags
      - main
  cache:
    paths:
      - ${PRE_COMMIT_HOME}
  before_script:
    - pip install pre-commit
  script:
    - pre-commit run --all-files