Docs: various improvements #174
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 pushes to `main` and `develop` and on all pull requests. | |
| push: | |
| branches: | |
| - main | |
| - develop | |
| paths-ignore: | |
| - '**.md' | |
| pull_request: | |
| # Allow manually triggering the workflow. | |
| workflow_dispatch: | |
| jobs: | |
| #### TEST STAGE #### | |
| test: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| php: ['7.0', '7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.3'] | |
| coverage: [false] | |
| # Run code coverage only on high/low PHP. | |
| include: | |
| - php: 5.6 | |
| coverage: true | |
| - php: 8.2 | |
| coverage: true | |
| continue-on-error: ${{ matrix.php == '8.3' }} | |
| name: "Tests: PHP ${{ matrix.php }}" | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v3 | |
| - name: Install PHP | |
| uses: shivammathur/setup-php@v2 | |
| with: | |
| php-version: ${{ matrix.php }} | |
| ini-values: error_reporting=E_ALL, display_errors=On | |
| coverage: ${{ matrix.coverage == true && 'xdebug' || 'none' }} | |
| # Install dependencies and handle caching in one go. | |
| # @link https://github.com/marketplace/actions/install-composer-dependencies | |
| - name: Install Composer dependencies - normal | |
| if: matrix.php != '8.3' | |
| 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: Install Composer dependencies - ignore PHP restrictions | |
| if: matrix.php == '8.3' | |
| uses: "ramsey/composer-install@v2" | |
| with: | |
| composer-options: --ignore-platform-req=php+ | |
| # Bust the cache at least once a month - output format: YYYY-MM. | |
| custom-cache-suffix: $(date -u "+%Y-%m") | |
| - name: Lint PHP files against parse errors | |
| run: composer lint | |
| - name: Run the unit tests | |
| if: ${{ matrix.coverage == false }} | |
| run: composer test | |
| - 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. | |
| - name: Switch to PHP 7.4 | |
| if: ${{ success() && matrix.coverage == true && startsWith( matrix.php, '8' ) }} | |
| 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 }} | |
| 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 |