Skip to content

Update README

Update README #12

Workflow file for this run

name: CI
on: [push, pull_request]
jobs:
static:
name: Static Analysis
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Psalm
uses: docker://vimeo/psalm-github-actions
with:
security_analysis: true
report_file: results.sarif
composer_ignore_platform_reqs: true
- name: Upload Security Analysis results to GitHub
uses: github/codeql-action/upload-sarif@v2
with:
sarif_file: results.sarif
# we may use whatever way to install phpcs, just specify the path on the next step
# however, curl seems to be the fastest
- name: Install PHP_CodeSniffer
run: |
curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
php phpcs.phar --version
- uses: tinovyatkin/action-php-codesniffer@v1
with:
files: "**.php" # you may customize glob as needed
phpcs_path: php phpcs.phar
standard: phpcs.xml
unittest:
runs-on: ubuntu-latest
strategy:
matrix:
php:
- version: 7.4
coverage: false
composer-args: ''
- version: 8.0
coverage: false
composer-args: ''
- version: 8.1
coverage: false
composer-args: ''
- version: 8.2
coverage: false
composer-args: ''
- version: 8.3
coverage: true
composer-args: ''
- version: 8.4
coverage: false
composer-args: '--ignore-platform-req=php'
prefer-lowest: ['', '--prefer-lowest']
name: Unit Tests - PHP ${{ matrix.php.version }} ${{ matrix.prefer-lowest }}
steps:
- uses: actions/checkout@v4
- name: Install PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php.version }}
- name: Validate composer.json and composer.lock
run: composer validate --strict
- name: Cache Composer packages
id: composer-cache
uses: actions/cache@v4
with:
path: vendor
key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
restore-keys: |
${{ runner.os }}-php-
- name: Install dependencies
run: composer update --prefer-dist --no-progress --with-all-dependencies ${{ matrix.prefer-lowest }} ${{ matrix.php.composer-args }}
- name: Run test suite
if: ${{ ! matrix.php.coverage }}
run: ./vendor/bin/phpunit
- name: Run test suite with code coverage
if: ${{ matrix.php.coverage }}
run: ./vendor/bin/phpunit --coverage-clover=build/logs/clover.xml
env:
XDEBUG_MODE: coverage
- name: Upload code coverage to Scrutinizer
run: |
wget https://scrutinizer-ci.com/ocular.phar
php ocular.phar code-coverage:upload --format=php-clover build/logs/clover.xml || true