Workflow to publish phpdoc to github pages (#1418) #2814
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: PHP QA | |
| on: | |
| push: | |
| branches: [ main ] | |
| pull_request: | |
| branches: [ main ] | |
| jobs: | |
| php: | |
| runs-on: ubuntu-latest | |
| continue-on-error: ${{ matrix.experimental }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| php-version: ['8.1', '8.2', '8.3'] | |
| experimental: [false] | |
| composer_args: [""] | |
| include: | |
| - php-version: 8.4 | |
| experimental: true | |
| composer_args: "--ignore-platform-reqs" | |
| env: | |
| extensions: ast, grpc, opentelemetry, protobuf | |
| steps: | |
| - name: Set cache key | |
| id: key | |
| run: | | |
| echo "key=$(date +'%Y-%U')" >> $GITHUB_ENV | |
| - uses: actions/checkout@v4 | |
| - uses: gacts/run-and-post-run@v1 | |
| id: post-run-command | |
| with: | |
| post: | | |
| echo "::group::Steps" | |
| echo "composer=${{steps.composer.outcome}}" | |
| echo "style=${{steps.style.outcome}}" | |
| echo "deps=${{steps.deps.outcome}}" | |
| echo "phan=${{steps.phan.outcome}}" | |
| echo "psalm=${{steps.psalm.outcome}}" | |
| echo "phpstan=${{steps.phpstan.outcome}}" | |
| echo "unit=${{steps.unit.outcome}}" | |
| echo "integration=${{steps.integration.outcome}}" | |
| echo "::endgroup::" | |
| if [ ${{ steps.composer.outcome == 'failure' || steps.style.outcome == 'failure' || steps.deps.outcome == 'failure' || steps.phan.outcome == 'failure' || steps.psalm.outcome == 'failure' || steps.phpstan.outcome == 'failure' || steps.unit.outcome == 'failure' || steps.integration.outcome == 'failure' }} == true ]; then \ | |
| echo "::error::One or more steps failed"; \ | |
| fi | |
| - name: Setup cache environment | |
| id: extcache | |
| uses: shivammathur/cache-extensions@v1 | |
| with: | |
| php-version: ${{ matrix.php-version }} | |
| extensions: ${{ env.extensions }} | |
| key: ${{ env.key }} | |
| - name: Cache extensions | |
| uses: actions/cache@v4 | |
| with: | |
| path: ${{ steps.extcache.outputs.dir }} | |
| key: ${{ steps.extcache.outputs.key }} | |
| restore-keys: ${{ steps.extcache.outputs.key }} | |
| - name: Setup PHP | |
| uses: shivammathur/setup-php@v2 | |
| with: | |
| php-version: ${{ matrix.php-version }} | |
| coverage: xdebug | |
| tools: php-cs-fixer | |
| extensions: ${{ env.extensions }} | |
| - name: Validate composer.json | |
| run: composer validate | |
| - name: Cache Composer packages | |
| id: composer-cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: vendor | |
| key: ${{ runner.os }}-${{ matrix.php-version }}-php-${{ hashFiles('**/composer.json') }} | |
| restore-keys: | | |
| ${{ runner.os }}-${{ matrix.php-version }}-php- | |
| - name: Cache test tools | |
| id: test-tools-cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: vendor-bin | |
| key: ${{ runner.os }}-${{ matrix.php-version }}-php-${{ hashFiles('**/composer.json') }} | |
| restore-keys: | | |
| ${{ runner.os }}-${{ matrix.php-version }}-php- | |
| - name: Install dependencies | |
| id: composer | |
| if: steps.composer-cache.outputs.cache-hit != 'true' | |
| run: composer install --prefer-dist --no-progress --no-suggest ${{ matrix.composer_args }} | |
| - name: Check Style | |
| id: style | |
| continue-on-error: ${{ matrix.experimental }} | |
| env: | |
| PHP_CS_FIXER_IGNORE_ENV: 1 | |
| run: vendor-bin/php-cs-fixer/vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php --dry-run --stop-on-violation --using-cache=no -vvv | |
| - name: Check Dependencies | |
| id: deps | |
| continue-on-error: ${{ matrix.experimental }} | |
| run: vendor-bin/deptrac/vendor/bin/deptrac --formatter=github-actions --report-uncovered | |
| - name: Run Phan | |
| id: phan | |
| continue-on-error: ${{ matrix.experimental }} | |
| env: | |
| XDEBUG_MODE: off | |
| PHAN_DISABLE_XDEBUG_WARN: 1 | |
| run: vendor-bin/phan/vendor/bin/phan | |
| - name: Run Psalm | |
| id: psalm | |
| continue-on-error: ${{ matrix.experimental }} | |
| run: vendor-bin/psalm/vendor/bin/psalm --output-format=github | |
| - name: Run Phpstan | |
| id: phpstan | |
| continue-on-error: ${{ matrix.experimental }} | |
| run: vendor/bin/phpstan analyse --error-format=github | |
| - name: Run PHPUnit (unit tests) | |
| id: unit | |
| continue-on-error: ${{ matrix.experimental }} | |
| run: php -dzend.assertions=1 vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover --testsuite unit | |
| - name: Run PHPUnit (integration tests) | |
| id: integration | |
| continue-on-error: ${{ matrix.experimental }} | |
| run: vendor/bin/phpunit --testsuite integration | |
| - name: Code Coverage | |
| uses: codecov/codecov-action@v4 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| files: ./coverage.clover | |
| flags: ${{ matrix.php-version }} | |
| verbose: false | |
| packages: | |
| uses: opentelemetry-php/gh-workflows/.github/workflows/validate-packages.yml@main | |
| needs: php | |
| with: | |
| matrix_extension: '["ast, json, grpc"]' | |
| matrix_php_version: '["8.1", "8.2", "8.3"]' | |
| install_directory: '~/.test/.packages' |