pre-commit.yml

name: pre-commit

on:
  workflow_dispatch:
  pull_request:
  push:
    branches: [exec]
    paths-ignore:
      - 'installation/constraints-*[0-9].txt'

jobs:
  pre-commit:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: [ "3.9", "3.10", "3.11", "3.12", "3.13", "3.14" ]
    name: Pre-commit python ${{ matrix.python-version }}
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 100
      - uses: actions/setup-python@v6
        with:
          python-version: ${{ matrix.python-version }}
          cache: 'pip'
          cache-dependency-path: |
            installation/requirements.txt
            installation/mypy-requirements.txt
            installation/dev-requirements.txt
          architecture: x64
      - name: 'Install requirements (standard or constraints ${{ matrix.python-version }})'
        run: |
          pip install --upgrade pip wheel
          constraints_file="installation/constraints-${{ matrix.python-version }}.txt"
          regen_constraints=
          if [ -f "$constraints_file" ] ; then
            at="$(git --no-pager log -p -1 "--format=tformat:%at" --no-patch -- "$constraints_file")"
            dat="$(git --no-pager log -p -1 "--format=tformat:%at" --no-patch -- "installation/requirements.txt")"
            if [ "$at" -lt "$dat" ] ; then
              regen_constraints=true
            fi
          else
            regen_constraints=true
          fi
          if [ -n "$regen_constraints" ] ; then
            pip install -r installation/requirements.txt
            pip freeze > "$constraints_file"
            grep -vF git+ "$constraints_file" > "$constraints_file"-relaxed
          else
            grep -vF git+ "$constraints_file" > "$constraints_file"-relaxed
            pip install -r installation/requirements.txt -c "$constraints_file"-relaxed
          fi
      - name: 'Install development requirements'
        run: |
          pip install -r installation/dev-requirements.txt -r installation/mypy-requirements.txt -c installation/constraints-${{ matrix.python-version }}.txt-relaxed
      - name: MyPy cache
        uses: actions/cache@v5
        with:
          path: '.mypy_cache/[0-9]*'
          key: mypy-${{ matrix.python-version }}
      - name: 'pre-commit'
        uses: pre-commit/action@v3.0.1
#        if: ${{ matrix.python-version != '3.6' }}
        with:
          extra_args: --all -c .pre-commit-config.yaml
 #     - name: 'pre-commit (custom Python ${{ matrix.python-version }})'
 #       uses: pre-commit/action@v3.0.1
 #       if: ${{ matrix.python-version == '3.6' }}
 #       with:
 #         extra_args: --all -c .pre-commit-config-gh-${{ matrix.python-version }}.yaml
      - name: CPU database cache restore
        id: cache-cpu-databases-restore
        uses: actions/cache/restore@v5
        with:
          path: |
            cpumark_table.csv
            cpu-spec-dataset
          key: cpu_databases
      - name: CPU database population
        if: steps.cache-cpu-databases-restore.outputs.cache-hit != 'true'
        run: |
          python -m treecript.tdp_sources cpumark_table.tsv
          git clone https://github.com/JosuaCarl/cpu-spec-dataset
      - name: CPU database cache save
        if: steps.cache-cpu-databases-restore.outputs.cache-hit != 'true'
        id: cache-cpu-databases-save
        uses: actions/cache/save@v5
        with:
          path: |
            cpumark_table.csv
            cpu-spec-dataset
          key: ${{ steps.cache-cpu-databases-restore.outputs.cache-primary-key }}
      - name: 'pytest + coverage (${{ matrix.python-version }})'
        run: |
          CACHED_CPU_SPEC_DATASET=${PWD}/cpu-spec-dataset CACHED_CPUMARK_DATASET=${PWD}/cpumark_table.tsv pytest --cov=treecript
      - name: Get transitive dependencies licences
        id: license_check_print_report
#        continue-on-error: true
        uses: pilosus/action-pip-license-checker@v3.1.0
        with:
          requirements: installation/constraints-${{ matrix.python-version }}.txt
#      - name: Check transitive dependencies licences
#        id: license_check_report
#        uses: pilosus/action-pip-license-checker@v3.1.0
#        with:
#          requirements: installation/constraints-${{ matrix.python-version }}.txt
#          fail: 'StrongCopyleft'
#          exclude: '(?i)^(pylint|dulwich|docutils).*'
      - name: Print licences report
        if: ${{ always() }}
        run: echo "${{ steps.license_check_print_report.outputs.report }}"
      - uses: actions/upload-artifact@v7
        with:
          name: pre-commit-${{ matrix.python-version }}
          retention-days: 2
          path: installation/constraints-${{ matrix.python-version }}.txt

  pull_request_changes:
    # Do this only when it is not a pull request validation
    if: github.event_name != 'pull_request'
    runs-on: ubuntu-latest
    name: Pull request with the newly generated contents
    needs:
      - pre-commit
    steps:
      - name: Get analysis timestamp
        id: timestamp
        run: echo "timestamp=$(date -Is)" >> "$GITHUB_OUTPUT"
      - uses: actions/checkout@v6
      - uses: actions/download-artifact@v8
        id: download
        with:
          pattern: pre-commit-*
          merge-multiple: true
          path: changes-dir
      - name: Move artifacts to their right place
        id: move
        run: |
          skip=true
          if [ -d "${{steps.download.outputs.download-path}}" ] ; then
            for con in "${{steps.download.outputs.download-path}}"/installation/constraints-*.txt ; do
              case "$con" in
                */constraints-\*.txt)
                  break
                  ;;
                *)
                  cp -p "$con" installation
                  skip=false
                  ;;
              esac
            done
          fi
          echo "skip=$skip" >> "$GITHUB_OUTPUT"
      - name: Create Pull Request
        id: cpr
        uses: peter-evans/create-pull-request@v8
        if: steps.move.outputs.skip == 'false'
        with:
          title: Updated constraints (triggered on ${{ steps.timestamp.outputs.timestamp }} by ${{ github.sha }})
          branch: create-pull-request/patch-constraints
          add-paths: installation/constraints-*.txt
          delete-branch: true
          commit-message: "[create-pull-request] Automatically commit updated contents (constraints)"
      - name: Check outputs
        if: ${{ steps.cpr.outputs.pull-request-number }}
        run: |
          echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}" >> "$GITHUB_STEP_SUMMARY"
          echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}" >> "$GITHUB_STEP_SUMMARY"