mirror of
https://github.com/Dolibarr/dolibarr.git
synced 2026-01-04 08:02:22 +01:00
19ac1e4b02
The PHPStan steps run a long time for the latest runs and I suspect that this may be because of a bad cache, possibly includeing: ``` Result cache was not saved because of non-ignorable exception: Syntax error, unexpected } on line 378 ``` . This change should only save the cache if the run was successful or if no cache was loaded. The possibly preserves a cache that still reduces the run time. For instance, the following got an empty cache, saved at 2024-01-19T21:28:22.18Z. - https://github.com/Dolibarr/dolibarr/actions/runs/7589384926 That was an aborted run: - https://github.com/Dolibarr/dolibarr/actions/runs/7589372703/job/20673878193 So I added `cancelled()` to avoid overwriting valid cache and phpstan cache will only be written if the outcome was success or if the cache could not be loaded before. I also updated the version for the cache action.
73 lines
2.6 KiB
YAML
73 lines
2.6 KiB
YAML
---
|
|
name: pre-commit
|
|
on:
|
|
pull_request:
|
|
push:
|
|
jobs:
|
|
pre-commit:
|
|
runs-on: ubuntu-latest
|
|
env:
|
|
LOG_TO_CS: .github/logToCs.py
|
|
RAW_LOG: pre-commit.log
|
|
CS_XML: pre-commit.xml
|
|
steps:
|
|
- name: Install required tools
|
|
run: sudo apt-get update && sudo apt-get install cppcheck
|
|
if: false
|
|
# Checkout git sources to analyze
|
|
- uses: actions/checkout@v4
|
|
# ???
|
|
- name: Create requirements.txt if no requirements.txt or pyproject.toml
|
|
run: |-
|
|
[ -r requirements.txt ] || [ -r pyproject.toml ] || touch requirements.txt
|
|
# Install python and pre-commit tool
|
|
- uses: actions/setup-python@v5
|
|
with:
|
|
cache: pip
|
|
python-version: '3.11'
|
|
- run: python -m pip install pre-commit regex
|
|
# Restore previous cache of precommit
|
|
- uses: actions/cache/restore@v4
|
|
with:
|
|
path: ~/.cache/pre-commit/
|
|
key: pre-commit-4|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml') }}
|
|
# Run all the precommit tools (defined into pre-commit-config.yaml). We can force exclusion of some of them here.
|
|
- name: Run pre-commit hooks
|
|
env:
|
|
# SKIP is used by pre-commit to not execute certain hooks
|
|
SKIP: no-commit-to-branch,php-cs,php-cbf,trailing-whitespace,end-of-file-fixer
|
|
run: |
|
|
set -o pipefail
|
|
pre-commit gc
|
|
pre-commit run --show-diff-on-failure --color=always --all-files | tee ${RAW_LOG}
|
|
# If error, we convert log in the checkstyle format
|
|
- name: Convert Raw Log to CheckStyle format
|
|
if: ${{ failure() }}
|
|
run: |
|
|
python ${LOG_TO_CS} ${RAW_LOG} ${CS_XML}
|
|
# Annotate the git sources with the log messages
|
|
- name: Annotate Source Code with Messages
|
|
uses: staabm/annotate-pull-request-from-checkstyle-action@v1
|
|
if: ${{ failure() }}
|
|
with:
|
|
files: ${{ env.CS_XML }}
|
|
notices-as-warnings: true # optional
|
|
prepend-filename: true # optional
|
|
# Save the precommit cache
|
|
- uses: actions/cache/save@v4
|
|
if: ${{ ! cancelled() }}
|
|
with:
|
|
path: ~/.cache/pre-commit/
|
|
key: pre-commit-4|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml')
|
|
}}
|
|
# Upload result log files of precommit into the Artifact shared store
|
|
- name: Provide log as artifact
|
|
uses: actions/upload-artifact@v4
|
|
if: ${{ ! cancelled() }}
|
|
with:
|
|
name: precommit-logs
|
|
path: |
|
|
${{ env.RAW_LOG }}
|
|
${{ env.CS_XML }}
|
|
retention-days: 2
|