Skip to content

Improve PHP CI workflow #753

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 0 additions & 49 deletions .github/workflows/codeql-analysis.yml

This file was deleted.

101 changes: 78 additions & 23 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -1,60 +1,115 @@
name: Main Workflow
name: PHP CI

on: ["pull_request"]
on:
push:
branches:
- main
- develop
pull_request:
branches:
- main
- develop
workflow_dispatch: {}

jobs:
run:
name: Run
php-test:
name: PHP Test
runs-on: ubuntu-latest

strategy:
matrix:
php-version: [ 7.3, 8.2 ]
php-version: [ '7.3', '8.2', '8.4' ]
include:
- php-version: '8.2'
validate: true

steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php-version }}
tools: composer:v2

- name: Validate composer.json and composer.lock
if: matrix.validate
run: composer validate --strict

- name: Check PHP syntax
if: matrix.validate
run: find -L . -path ./vendor -prune -o -path ./tests -prune -o -name '*.php' -print0 | xargs -0 -n 1 -P 4 php -l

- name: Install dependencies
run: composer install --prefer-dist --no-progress

- name: Run unit tests
run: vendor/bin/phpunit --testsuite=unit --coverage-clover build/clover.xml --log-junit build/tests-log.xml

- name: Clean up reports
run: sed -i "s;`pwd`/;;g" build/*.xml

php-lint:
Comment on lines +16 to +54

Check warning

Code scanning / CodeQL

Workflow does not contain permissions Medium

Actions job or workflow does not limit the permissions of the GITHUB_TOKEN. Consider setting an explicit permissions block, using the following as a minimal starting point: {contents: read}
name: PHP Lint
needs: php-test
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
# Disabling shallow clone to improve relevancy of SonarCloud reporting
fetch-depth: 0

- name: Validate composer.json and composer.lock
run: composer validate --strict
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.2'
tools: composer:v2

- name: Install dependencies
run: composer install --prefer-dist --no-progress

- name: Run PHP Code Sniffer
run: vendor/bin/phpcs --exclude=Generic.Files.LineLength

integration-tests:
Comment on lines +55 to +76

Check warning

Code scanning / CodeQL

Workflow does not contain permissions Medium

Actions job or workflow does not limit the permissions of the GITHUB_TOKEN. Consider setting an explicit permissions block, using the following as a minimal starting point: {contents: read}
name: Integration Tests
needs: [php-test, php-lint]
runs-on: ubuntu-latest

# Only run integration tests on pull requests with release label and from the main repository
if: |
github.event_name == 'pull_request' &&
contains(github.event.pull_request.labels.*.name, 'release') &&
github.event.pull_request.head.repo.full_name == github.repository

steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.2'
tools: composer:v2

- name: Install dependencies
run: composer install --prefer-dist --no-progress

- name: Run integration tests
run: vendor/bin/phpunit --testsuite=integration --no-coverage
env:
INTEGRATION_USERNAME: ${{ secrets.INTEGRATION_USERNAME }}
INTEGRATION_PASSWORD: ${{ secrets.INTEGRATION_PASSWORD }}
INTEGRATION_X_API_KEY: ${{ secrets.INTEGRATION_X_API_KEY }}
INTEGRATION_MERCHANT_ACCOUNT: ${{ secrets.INTEGRATION_MERCHANT_ACCOUNT }}
INTEGRATION_DONATION_ACCOUNT: ${{ secrets.INTEGRATION_DONATION_ACCOUNT }}
INTEGRATION_SKIN_CODE: ${{ secrets.INTEGRATION_SKIN_CODE }}
INTEGRATION_HMAC_SIGNATURE: ${{ secrets.INTEGRATION_HMAC_SIGNATURE }}
INTEGRATION_STORE_PAYOUT_USERNAME: ${{ secrets.INTEGRATION_STORE_PAYOUT_USERNAME }}
INTEGRATION_STORE_PAYOUT_PASSWORD: ${{ secrets.INTEGRATION_STORE_PAYOUT_PASSWORD }}
INTEGRATION_REVIEW_PAYOUT_USERNAME: ${{ secrets.INTEGRATION_REVIEW_PAYOUT_USERNAME }}
INTEGRATION_REVIEW_PAYOUT_PASSWORD: ${{ secrets.INTEGRATION_REVIEW_PAYOUT_PASSWORD }}

Check warning

Code scanning / CodeQL

Workflow does not contain permissions Medium

Actions job or workflow does not limit the permissions of the GITHUB_TOKEN. Consider setting an explicit permissions block, using the following as a minimal starting point: {contents: read}

- name: Run unit tests
run: vendor/bin/phpunit --testsuite=unit --coverage-clover build/clover.xml --log-junit build/tests-log.xml

# PHPUnit generates absolute file paths and SonarCloud expects relative file paths. This command removes the
# current working directory from the report files.
- name: Clean up reports
run: sed -i "s;`pwd`/;;g" build/*.xml

- name: Run PHP Code Sniffer
run: vendor/bin/phpcs --exclude=Generic.Files.LineLength

- name: Make sure project files are compilable
run: find -L . -path ./vendor -prune -o -path ./tests -prune -o -name '*.php' -print0 | xargs -0 -n 1 -P 4 php -l