reusable-linters.yml

---

name: ♲ 🚨

on:  # yamllint disable-line rule:truthy
  workflow_call:

env:
  TOX_VERSION: tox < 4.12

jobs:
  linters:
    name: >-
      ${{ matrix.toxenv }}/${{ matrix.python-version }}@${{ matrix.os }}
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        python-version:
        - 3.11
        os:
        - ubuntu-latest
        toxenv:
        - lint
        - build-docs
        - make-changelog

    env:
      PY_COLORS: 1
      TOX_PARALLEL_NO_SPINNER: 1
      TOXENV: ${{ matrix.toxenv }}

    steps:
    - uses: actions/checkout@v4.1.6
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5.3.0
      with:
        python-version: ${{ matrix.python-version }}
    - name: >-
        Calculate Python interpreter version hash value
        for use in the cache key
      id: calc-cache-key-py
      run: |
        from hashlib import sha512
        from os import environ
        from pathlib import Path
        from sys import version

        FILE_APPEND_MODE = 'a'

        hash = sha512(version.encode()).hexdigest()

        with Path(environ['GITHUB_OUTPUT']).open(
                mode=FILE_APPEND_MODE,
        ) as outputs_file:
            print(f'py-hash-key={hash}', file=outputs_file)
      shell: python
    - name: Pre-commit cache
      uses: actions/cache@v4.0.2
      with:
        path: ~/.cache/pre-commit
        key: >-
          ${{ runner.os }}-pre-commit-${{
          steps.calc-cache-key-py.outputs.py-hash-key }}-${{
          hashFiles('setup.cfg') }}-${{ hashFiles('tox.ini') }}-${{
          hashFiles('pyproject.toml') }}-${{
          hashFiles('.pre-commit-config.yaml') }}-${{
          hashFiles('pytest.ini') }}
    - name: Pip cache
      uses: actions/cache@v4.0.2
      with:
        path: ~/.cache/pip
        key: >-
          ${{ runner.os }}-pip-${{
          steps.calc-cache-key-py.outputs.py-hash-key }}-${{
          hashFiles('setup.cfg') }}-${{ hashFiles('tox.ini') }}-${{
          hashFiles('pyproject.toml') }}-${{
          hashFiles('.pre-commit-config.yaml') }}-${{
          hashFiles('pytest.ini') }}
        restore-keys: |
          ${{ runner.os }}-pip-
          ${{ runner.os }}-
    - name: Install tox
      run: >-
        python -m
        pip install
        --user
        '${{ env.TOX_VERSION }}'
    - name: Log installed dists
      run: python -m pip freeze --all
    - name: Initialize tox envs
      run: |
        python -m tox --parallel auto --parallel-live --notest
    - name: Initialize pre-commit envs if needed
      run: >-
        test -d .tox/lint
        && .tox/lint/bin/python -m pre_commit install-hooks
        || :
    - name: Test with tox
      run: python -m tox --parallel auto --parallel-live

...