Use pre-commit as a linter the CI suite

.github/dependabot.yml

@@ -1,10 +1,10 @@
 version: 2
 updates:
-- package-ecosystem: pip
-  directory: "/"
-  schedule:
-    interval: daily
-- package-ecosystem: github-actions
-  directory: "/"
-  schedule:
-    interval: daily
+  - package-ecosystem: pip
+    directory: "/"
+    schedule:
+      interval: daily
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: daily

.github/workflows/ci.yml

@@ -1,32 +1,31 @@
 name: CI
-
 on:
   push:
     branches:
       - main
   pull_request:
 jobs:
-
-  lint:
+  pre-commit:
+    if: startsWith(github.head_ref, 'dependabot/') != true
+    name: pre-commit
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        lint-command:
-          - "ruff format --check --diff ."
-          - "ruff check --output-format=github ."
+    outputs:
+      file-names: ${{ steps.diff.outputs.file-names }}
     steps:
       - uses: actions/checkout@v6
-      - uses: actions/setup-python@v6
         with:
-          python-version: "3.x"
-          cache: 'pip'
-          cache-dependency-path: '**/pyproject.toml'
-      - run: python -m pip install -e .[lint]
-      - run: ${{ matrix.lint-command }}
-
+          fetch-depth: 0
+      - run: echo "file-names=$(git diff --name-only ${{ github.event.pull_request.base.sha }} HEAD | grep '\.py$' | tr '\n' ' ' || true)" >> "$GITHUB_OUTPUT"
+        id: diff
+      - uses: astral-sh/setup-uv@v7
+      - uses: actions/cache@v5
+        with:
+          path: ~/.cache/pre-commit/
+          key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
+      - run: SKIP=$(yq '.ci.skip' -o csv .pre-commit-config.yaml) uvx pre-commit run --all-files --show-diff-on-failure
   dist:
     runs-on: ubuntu-latest
-    needs: [lint]
+    needs: [pre-commit]
     steps:
       - uses: actions/checkout@v6
       - uses: actions/setup-python@v6
@@ -37,11 +36,9 @@ jobs:
       - run: python -m pip install --upgrade pip build twine
       - run: python -m build --sdist --wheel
       - run: python -m twine check dist/*
-
-
   docs:
     runs-on: ubuntu-latest
-    needs: [lint]
+    needs: [pre-commit]
     steps:
       - uses: actions/checkout@v6
       - name: setup Python
@@ -52,10 +49,9 @@ jobs:
           cache-dependency-path: '**/pyproject.toml'
       - run: python -m pip install -e .[docs]
       - run: python -m sphinx -b html -W docs docs/_build
-
   PyTest:
     runs-on: ubuntu-latest
-    needs: [lint]
+    needs: [pre-commit]
     strategy:
       matrix:
         python-version:

.github/workflows/release.yml

@@ -1,18 +1,13 @@
 name: Release
-
 on:
   release:
     types: [published]
   workflow_dispatch:
-
 permissions:
   id-token: write
-
 jobs:
-
   release-build:
     runs-on: ubuntu-latest
-
     steps:
       - uses: actions/checkout@v6
       - uses: actions/setup-python@v6
@@ -24,14 +19,12 @@ jobs:
         with:
           name: release-dists
           path: dist/
-
   pypi-publish:
     runs-on: ubuntu-latest
     needs:
       - release-build
     permissions:
       id-token: write
-
     steps:
       - uses: actions/download-artifact@v7
         with:

.pre-commit-config.yaml

@@ -0,0 +1,45 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: check-merge-conflict
+      - id: check-ast
+      - id: check-toml
+      - id: check-yaml
+      - id: check-symlinks
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: no-commit-to-branch
+        args: [--branch, main]
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.21.2
+    hooks:
+      - id: pyupgrade
+  - repo: https://github.com/adamchainz/django-upgrade
+    rev: 1.29.1
+    hooks:
+      - id: django-upgrade
+  - repo: https://github.com/hukkin/mdformat
+    rev: 1.0.0
+    hooks:
+      - id: mdformat
+        additional_dependencies:
+          - mdformat-ruff
+          - mdformat-footnote
+          - mdformat-gfm
+          - mdformat-gfm-alerts
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.9
+    hooks:
+      - id: ruff-check
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+  - repo: https://github.com/google/yamlfmt
+    rev: v0.20.0
+    hooks:
+      - id: yamlfmt
+ci:
+  autoupdate_schedule: weekly
+  skip:
+    - no-commit-to-branch

.readthedocs.yaml

@@ -1,18 +1,13 @@
 # .readthedocs.yaml
 # Read the Docs configuration file
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
 version: 2
-
 build:
   os: ubuntu-20.04
   tools:
     python: "3.10"
-
 sphinx:
   configuration: docs/conf.py
-
-
 python:
   install:
     - method: pip

README.md

@@ -5,7 +5,6 @@
 [![djversion](https://img.shields.io/pypi/djversions/django-health-check.svg)](https://pypi.python.org/pypi/django-health-check/)
 [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://pypi.python.org/pypi/django-health-check/)
 
-
 This project checks for various conditions and provides reports when anomalous
 behavior is detected.
 
@@ -104,6 +103,7 @@ threshold settings; otherwise below defaults are assumed.
 ```
 
 To use Health Check Subsets, Specify a subset name and associate it with the relevant health check services to utilize Health Check Subsets. (New in version 3.18.0)
+
 ```python
     HEALTH_CHECK = {
         # .....
@@ -117,6 +117,7 @@ To use Health Check Subsets, Specify a subset name and associate it with the rel
 ```
 
 To add checks on a specific database, it's possible to parameterize `DatabaseBackend` to use a specific database:
+
 ```python
     HEALTH_CHECK = {
         # .....
@@ -131,6 +132,7 @@ To add checks on a specific database, it's possible to parameterize `DatabaseBac
 ```
 
 To only execute specific subset of health check
+
 ```shell
 curl -X GET -H "Accept: application/json" http://www.example.com/ht/startup-probe/
 ```
@@ -149,7 +151,7 @@ rabbit server. For example:
     BROKER_URL = "amqp://myuser:mypassword@localhost:5672/myvhost"
 ```
 
-To use the Redis healthcheck, please make sure that there is a variable named ``REDIS_URL``
+To use the Redis healthcheck, please make sure that there is a variable named `REDIS_URL`
 on django.conf.settings with the required format to connect to your redis server. For example:
 
 ```python
@@ -163,7 +165,7 @@ It can be customized by setting `HEALTHCHECK_CACHE_KEY` to another value:
     HEALTHCHECK_CACHE_KEY = "custom_healthcheck_key"
 ```
 
-Additional connection options may be specified by defining a variable ``HEALTHCHECK_REDIS_URL_OPTIONS`` on the settings module.
+Additional connection options may be specified by defining a variable `HEALTHCHECK_REDIS_URL_OPTIONS` on the settings module.
 
 ## Setting up monitoring
 
@@ -307,7 +309,6 @@ This should yield the following output:
 
 Similar to the http version, a critical error will cause the command to quit with the exit code `1`.
 
-
 ## Other resources
 
 - [django-watchman](https://github.com/mwarkentin/django-watchman) is a package that does some of the same things in a slightly different way.

health_check/contrib/mail/__init__.py

@@ -1 +0,0 @@
-

pyproject.toml

@@ -61,9 +61,6 @@ test = [
   "boto3",
 ]
 docs = ["sphinx"]
-lint = [
-  "ruff==0.14.10",
-]
 
 [tool.flit.module]
 name = "health_check"