Docs: fix various incorrect type annotations #419
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 all pushes and on all pull requests. | |
| # Prevent the build from running when there are only irrelevant changes. | |
| push: | |
| paths-ignore: | |
| - '**.md' | |
| pull_request: | |
| # 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: | |
| build: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| php: ['5.4', '5.5', '5.6', '7.0', '7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3', '8.4'] | |
| name: "Build Phar on PHP: ${{ matrix.php }}" | |
| continue-on-error: ${{ matrix.php == '8.2' }} | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Setup PHP | |
| uses: shivammathur/setup-php@v2 | |
| with: | |
| php-version: ${{ matrix.php }} | |
| coverage: none | |
| ini-values: phar.readonly=Off, error_reporting=-1, display_errors=On | |
| - name: Build the phar | |
| run: php scripts/build-phar.php | |
| - name: Upload the PHPCS phar | |
| uses: actions/upload-artifact@v3 | |
| if: ${{ success() && matrix.php == '8.0' }} | |
| with: | |
| name: phpcs-phar | |
| path: ./phpcs.phar | |
| if-no-files-found: error | |
| retention-days: 28 | |
| - name: Upload the PHPCBF phar | |
| uses: actions/upload-artifact@v3 | |
| if: ${{ success() && matrix.php == '8.0' }} | |
| with: | |
| name: phpcbf-phar | |
| path: ./phpcbf.phar | |
| if-no-files-found: error | |
| retention-days: 28 | |
| # Both the below only check a few files which are rarely changed and therefore unlikely to have issues. | |
| # This test is about testing that the phars are functional, *not* about whether the code style complies. | |
| - name: 'PHPCS: check code style using the Phar file to test the Phar is functional' | |
| run: php phpcs.phar ./scripts | |
| - name: 'PHPCBF: fix code style using the Phar file to test the Phar is functional' | |
| run: php phpcbf.phar ./scripts | |
| test: | |
| runs-on: ubuntu-latest | |
| needs: build | |
| strategy: | |
| # Keys: | |
| # - custom_ini: Whether to run with specific custom ini settings to hit very specific | |
| # code conditions. | |
| matrix: | |
| php: ['5.4', '5.5', '5.6', '7.0', '7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3', '8.4'] | |
| custom_ini: [false] | |
| include: | |
| # Builds running the basic tests with different PHP ini settings. | |
| - php: '5.5' | |
| custom_ini: true | |
| - php: '7.0' | |
| custom_ini: true | |
| name: "PHP: ${{ matrix.php }} ${{ matrix.custom_ini && ' with custom ini settings' || '' }}" | |
| continue-on-error: ${{ matrix.php == '8.4' }} | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Setup ini config | |
| id: set_ini | |
| run: | | |
| # Set the "short_open_tag" ini to make sure specific conditions are tested. | |
| # Also turn on error_reporting to ensure all notices are shown. | |
| if [[ ${{ matrix.custom_ini }} == true && "${{ matrix.php }}" == '5.5' ]]; then | |
| echo 'PHP_INI=error_reporting=-1, display_errors=On, date.timezone=Australia/Sydney, short_open_tag=On, asp_tags=On' >> $GITHUB_OUTPUT | |
| elif [[ ${{ matrix.custom_ini }} == true && "${{ matrix.php }}" == '7.0' ]]; then | |
| echo 'PHP_INI=error_reporting=-1, display_errors=On, date.timezone=Australia/Sydney, short_open_tag=On' >> $GITHUB_OUTPUT | |
| else | |
| echo 'PHP_INI=error_reporting=-1, display_errors=On' >> $GITHUB_OUTPUT | |
| fi | |
| - name: Install PHP | |
| uses: shivammathur/setup-php@v2 | |
| with: | |
| php-version: ${{ matrix.php }} | |
| ini-values: ${{ steps.set_ini.outputs.PHP_INI }} | |
| coverage: none | |
| tools: cs2pr | |
| # This action also handles the caching of the dependencies. | |
| - name: Set up node and enable caching of dependencies | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: '20' | |
| - name: Install external tools used in tests | |
| run: > | |
| npm install -g --fund false | |
| csslint | |
| eslint | |
| jshint | |
| # Install dependencies and handle caching in one go. | |
| # @link https://github.com/marketplace/actions/install-php-dependencies-with-composer | |
| - name: Install Composer dependencies | |
| if: ${{ matrix.php != '8.4' }} | |
| 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") | |
| # For PHP "nightly", we install with ignore platform reqs. | |
| - name: Install Composer dependencies - with ignore platform | |
| if: ${{ matrix.php == '8.4' }} | |
| uses: "ramsey/composer-install@v2" | |
| with: | |
| composer-options: --ignore-platform-req=php | |
| custom-cache-suffix: $(date -u "+%Y-%m") | |
| # Note: The code style check is run multiple times against every PHP version | |
| # as it also acts as an integration test. | |
| - name: 'PHPCS: set the path to PHP' | |
| run: php bin/phpcs --config-set php_path php | |
| - name: 'PHPUnit: run the tests' | |
| run: vendor/bin/phpunit tests/AllTests.php | |
| - name: 'PHPCS: check code style without cache, no parallel' | |
| if: ${{ matrix.custom_ini == false && matrix.php != '7.4' }} | |
| run: php bin/phpcs --no-cache --parallel=1 | |
| - name: 'PHPCS: check code style to show results in PR' | |
| if: ${{ matrix.custom_ini == false && matrix.php == '7.4' }} | |
| id: phpcs | |
| run: php bin/phpcs --no-cache --parallel=1 --report-full --report-checkstyle=./phpcs-report.xml | |
| - name: Show PHPCS results in PR | |
| if: ${{ always() && steps.phpcs.outcome == 'failure' && matrix.php == '7.4' }} | |
| run: cs2pr ./phpcs-report.xml | |
| - name: Download the PHPCS phar | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: phpcs-phar | |
| # This test specifically tests that the Phar which will be released works correctly on all PHP versions. | |
| - name: 'PHPCS: check code style using the Phar file' | |
| if: ${{ matrix.custom_ini == false }} | |
| run: php phpcs.phar |