You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
pixelfed/.github/workflows/php-psalm.yml

74 lines
2.5 KiB
YAML

name: PHP - Psalm
on:
push:
branches: [staging, dev, unstable]
pull_request:
branches: [staging, dev, unstable]
permissions:
contents: read
# Required for github/codeql-action/upload-sarif to publish Code Scanning alerts.
security-events: write
concurrency:
group: psalm-${{ github.ref }}
cancel-in-progress: true
jobs:
psalm:
name: Psalm type analysis
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v7
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.5'
extensions: mbstring, pdo_sqlite, bcmath, intl
coverage: none
- name: Cache Composer dependencies
uses: actions/cache@v6
with:
path: vendor
key: composer-8.5-${{ hashFiles('composer.lock') }}
restore-keys: composer-8.5-
- name: Install Composer dependencies
run: composer install --no-interaction --no-progress --prefer-dist
# --output-format=github emits workflow annotations so findings appear inline
# on the PR's Files changed view. --report writes SARIF for Code Scanning upload.
# Reporting only: `|| true` keeps the step (and job) green even when Psalm finds
# issues (or fails to run), so this workflow surfaces findings without ever
# blocking a PR.
- name: Run Psalm (type analysis, report only)
run: vendor/bin/psalm --output-format=github --report=psalm.sarif.json || true
# Psalm only writes the SARIF file when it runs far enough to produce a report.
# If it crashed early (e.g. bad config), skip the upload rather than pushing a
# blank SARIF, which would clear existing Code Scanning alerts.
- name: Check for SARIF report
id: sarif
if: ${{ !cancelled() }}
run: |
if [ -f psalm.sarif.json ]; then
echo "exists=true" >> "$GITHUB_OUTPUT"
else
echo "exists=false" >> "$GITHUB_OUTPUT"
echo "::warning::Psalm did not produce psalm.sarif.json; skipping Code Scanning upload."
fi
# Surface findings as Code Scanning alerts on the PR (Security tab). Runs even
# when the Psalm step failed, but only when a real SARIF file was produced.
- name: Upload SARIF to Code Scanning
if: ${{ !cancelled() && steps.sarif.outputs.exists == 'true' }}
uses: github/codeql-action/upload-sarif@v4
with:
sarif_file: psalm.sarif.json
category: psalm