Docs: various improvements #88
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Test | |
| on: | |
| # Run on relevant pushes to `main` and on all relevant pull requests. | |
| push: | |
| branches: | |
| - main | |
| paths-ignore: | |
| - '**.md' | |
| - '.gitattributes' | |
| - '.gitignore' | |
| - 'LICENSE' | |
| - '.phpcs.xml.dist' | |
| - 'phpcs.xml.dist' | |
| - '.github/dependabot.yml' | |
| - '.github/workflows/cs.yml' | |
| - 'images/**' | |
| pull_request: | |
| paths-ignore: | |
| - '**.md' | |
| - '.gitattributes' | |
| - '.gitignore' | |
| - 'LICENSE' | |
| - '.phpcs.xml.dist' | |
| - 'phpcs.xml.dist' | |
| - '.github/dependabot.yml' | |
| - '.github/workflows/cs.yml' | |
| - 'images/**' | |
| # Allow manually triggering the workflow. | |
| workflow_dispatch: | |
| # Cancels all previous workflow runs for the same branch that have not yet completed. | |
| concurrency: | |
| # The concurrency group contains the workflow name and the branch name. | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| test: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| php_version: ['5.4', '5.5', '5.6', '7.0', '7.2', '7.3', '7.4', '8.0', '8.1', '8.3'] | |
| coverage: [false] | |
| # Run code coverage only on high/medium/low PHP. | |
| include: | |
| - php_version: 5.3 | |
| coverage: true | |
| - php_version: 7.1 | |
| coverage: true | |
| - php_version: 8.2 | |
| coverage: true | |
| name: "Lint and test: PHP ${{ matrix.php_version }}" | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v3 | |
| - name: Install PHP | |
| uses: shivammathur/setup-php@v2 | |
| with: | |
| php-version: ${{ matrix.php_version }} | |
| ini-values: zend.assertions=1, error_reporting=-1, display_errors=On | |
| coverage: ${{ matrix.coverage == true && 'xdebug' || 'none' }} | |
| tools: cs2pr | |
| # YoastCS has a minimum PHP requirement of 5.4, so remove it and hard require Parallel Lint. | |
| - name: Adjust Composer dependencies (PHP 5.3) | |
| if: matrix.php_version == '5.3' | |
| run: | | |
| composer remove --dev --no-update --no-scripts yoast/yoastcs --no-interaction | |
| composer require --dev --no-update --no-scripts php-parallel-lint/php-parallel-lint --no-interaction | |
| # Install dependencies and handle caching in one go. | |
| # @link https://github.com/marketplace/actions/install-composer-dependencies | |
| - name: Install Composer dependencies | |
| uses: ramsey/composer-install@v2 | |
| with: | |
| # Bust the cache at least once a month - output format: YYYY-MM. | |
| custom-cache-suffix: $(date -u "+%Y-%m") | |
| - name: Lint against parse errors | |
| run: composer lint -- --checkstyle | cs2pr | |
| - name: Run the unit tests | |
| if: ${{ matrix.coverage == false }} | |
| run: vendor/bin/phpunit | |
| - name: Run the unit tests with code coverage | |
| if: ${{ matrix.coverage == true }} | |
| run: composer coverage | |
| # PHP Coveralls doesn't fully support PHP 8.x yet, so switch the PHP version. | |
| # Additionally Coveralls 1.x (which would be needed for PHP < 5.5) doesn't play nice with GH Actions. | |
| - name: Switch to PHP 7.4 | |
| if: ${{ success() && matrix.coverage == true }} | |
| uses: shivammathur/setup-php@v2 | |
| with: | |
| php-version: 7.4 | |
| coverage: none | |
| # Global install is used to prevent a conflict with the local composer.lock in PHP 8.0+. | |
| - name: Install Coveralls | |
| if: ${{ success() && matrix.coverage == true }} | |
| run: composer global require php-coveralls/php-coveralls:"^2.5.3" --no-interaction | |
| - name: Upload coverage results to Coveralls | |
| if: ${{ success() && matrix.coverage == true }} | |
| env: | |
| COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_TOKEN }} | |
| COVERALLS_PARALLEL: true | |
| COVERALLS_FLAG_NAME: php-${{ matrix.php_version }} | |
| run: php-coveralls -v -x build/logs/clover.xml | |
| coveralls-finish: | |
| needs: test | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Coveralls Finished | |
| uses: coverallsapp/github-action@v2 | |
| with: | |
| github-token: ${{ secrets.COVERALLS_TOKEN }} | |
| parallel-finished: true |