Bail out early if possible #783
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: CI | |
| on: # yamllint disable-line rule:truthy | |
| push: | |
| branches: ['**'] | |
| paths-ignore: | |
| - '**.md' | |
| pull_request: | |
| branches: [master, release-*] | |
| paths-ignore: | |
| - '**.md' | |
| workflow_dispatch: | |
| jobs: | |
| linter: | |
| name: Linter | |
| runs-on: ['ubuntu-latest'] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| # super-linter needs the full git history to get the | |
| # list of files that changed across commits | |
| fetch-depth: 0 | |
| - name: Lint Code Base | |
| uses: super-linter/super-linter/slim@v7 | |
| env: | |
| SAVE_SUPER_LINTER_OUTPUT: false | |
| # To report GitHub Actions status checks | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| FILTER_REGEX_EXCLUDE: .*/resources/xml/domdocument_(invalid_xml|empty).xml | |
| LINTER_RULES_PATH: 'tools/linters' | |
| LOG_LEVEL: NOTICE | |
| VALIDATE_ALL_CODEBASE: true | |
| VALIDATE_GITHUB_ACTIONS: true | |
| VALIDATE_JSON: true | |
| VALIDATE_PHP_BUILTIN: true | |
| VALIDATE_YAML: true | |
| VALIDATE_XML: true | |
| quality: | |
| name: Quality control | |
| runs-on: [ubuntu-latest] | |
| steps: | |
| - name: Setup PHP, with composer and extensions | |
| id: setup-php | |
| # https://github.com/shivammathur/setup-php | |
| uses: shivammathur/setup-php@v2 | |
| with: | |
| # Should be the higest supported version, so we can use the newest tools | |
| php-version: '8.4' | |
| tools: composer, composer-require-checker, composer-unused, phpcs | |
| extensions: ctype, date, dom, filter, libxml, pcre, spl, xml | |
| coverage: none | |
| - name: Setup problem matchers for PHP | |
| run: echo "::add-matcher::${{ runner.tool_cache }}/php.json" | |
| - uses: actions/checkout@v4 | |
| - name: Get composer cache directory | |
| run: echo COMPOSER_CACHE="$(composer config cache-files-dir)" >> "$GITHUB_ENV" | |
| - name: Cache composer dependencies | |
| uses: actions/cache@v4 | |
| with: | |
| path: $COMPOSER_CACHE | |
| key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }} | |
| restore-keys: ${{ runner.os }}-composer- | |
| - name: Validate composer.json and composer.lock | |
| run: composer validate | |
| - name: Install Composer dependencies | |
| run: composer install --no-progress --prefer-dist --optimize-autoloader | |
| - name: Check code for hard dependencies missing in composer.json | |
| run: composer-require-checker check --config-file=tools/composer-require-checker.json composer.json | |
| - name: Check code for unused dependencies in composer.json | |
| run: composer-unused --excludePackage=simplesamlphp/composer-xmlprovider-installer | |
| - name: PHP Code Sniffer | |
| run: phpcs | |
| - name: PHPStan | |
| run: | | |
| vendor/bin/phpstan analyze -c phpstan.neon | |
| - name: PHPStan (testsuite) | |
| run: | | |
| vendor/bin/phpstan analyze -c phpstan-dev.neon | |
| security: | |
| name: Security checks | |
| runs-on: [ubuntu-latest] | |
| steps: | |
| - name: Setup PHP, with composer and extensions | |
| # https://github.com/shivammathur/setup-php | |
| uses: shivammathur/setup-php@v2 | |
| with: | |
| # Should be the lowest supported version | |
| php-version: '8.1' | |
| extensions: ctype, date, dom, filter, libxml, pcre, spl, xml | |
| tools: composer | |
| coverage: none | |
| - name: Setup problem matchers for PHP | |
| run: echo "::add-matcher::${{ runner.tool_cache }}/php.json" | |
| - uses: actions/checkout@v4 | |
| - name: Get composer cache directory | |
| run: echo COMPOSER_CACHE="$(composer config cache-files-dir)" >> "$GITHUB_ENV" | |
| - name: Cache composer dependencies | |
| uses: actions/cache@v4 | |
| with: | |
| path: $COMPOSER_CACHE | |
| key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }} | |
| restore-keys: ${{ runner.os }}-composer- | |
| - name: Install Composer dependencies | |
| run: composer install --no-progress --prefer-dist --optimize-autoloader | |
| - name: Security check for locked dependencies | |
| run: composer audit | |
| - name: Update Composer dependencies | |
| run: composer update --no-progress --prefer-dist --optimize-autoloader | |
| - name: Security check for updated dependencies | |
| run: composer audit | |
| unit-tests-linux: | |
| name: "Unit tests, PHP ${{ matrix.php-versions }}, ${{ matrix.operating-system }}" | |
| runs-on: ${{ matrix.operating-system }} | |
| needs: [linter, quality, security] | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| operating-system: [ubuntu-latest] | |
| php-versions: ['8.1', '8.2', '8.3', '8.4'] | |
| steps: | |
| - name: Setup PHP, with composer and extensions | |
| # https://github.com/shivammathur/setup-php | |
| uses: shivammathur/setup-php@v2 | |
| with: | |
| php-version: ${{ matrix.php-versions }} | |
| extensions: ctype, date, dom, filter, libxml, pcre, spl, xml, xmlreader | |
| tools: composer | |
| ini-values: error_reporting=E_ALL | |
| coverage: pcov | |
| - name: Setup problem matchers for PHP | |
| run: echo "::add-matcher::${{ runner.tool_cache }}/php.json" | |
| - name: Setup problem matchers for PHPUnit | |
| run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json" | |
| - name: Set git to use LF | |
| run: | | |
| git config --global core.autocrlf false | |
| git config --global core.eol lf | |
| - uses: actions/checkout@v4 | |
| - name: Get composer cache directory | |
| run: echo COMPOSER_CACHE="$(composer config cache-files-dir)" >> "$GITHUB_ENV" | |
| - name: Cache composer dependencies | |
| uses: actions/cache@v4 | |
| with: | |
| path: $COMPOSER_CACHE | |
| key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }} | |
| restore-keys: ${{ runner.os }}-composer- | |
| - name: Install Composer dependencies | |
| run: composer install --no-progress --prefer-dist --optimize-autoloader | |
| - name: Run unit tests with coverage | |
| if: ${{ matrix.php-versions == '8.4' }} | |
| run: vendor/bin/phpunit | |
| - name: Run unit tests (no coverage) | |
| if: ${{ matrix.php-versions != '8.4' }} | |
| run: vendor/bin/phpunit --no-coverage | |
| - name: Save coverage data | |
| if: ${{ matrix.php-versions == '8.4' }} | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: coverage-data | |
| path: ${{ github.workspace }}/build | |
| unit-tests-windows: | |
| name: "Unit tests, PHP ${{ matrix.php-versions }}, ${{ matrix.operating-system }}" | |
| runs-on: ${{ matrix.operating-system }} | |
| needs: [linter, quality, security] | |
| strategy: | |
| fail-fast: true | |
| matrix: | |
| operating-system: [windows-latest] | |
| php-versions: ['8.1', '8.2', '8.3', '8.4'] | |
| steps: | |
| - name: Setup PHP, with composer and extensions | |
| # https://github.com/shivammathur/setup-php | |
| uses: shivammathur/setup-php@v2 | |
| with: | |
| php-version: ${{ matrix.php-versions }} | |
| extensions: ctype, date, dom, filter, libxml, pcre, spl, xml, xmlreader | |
| tools: composer | |
| ini-values: error_reporting=E_ALL | |
| coverage: none | |
| - name: Setup problem matchers for PHP | |
| run: echo "::add-matcher::${{ runner.tool_cache }}/php.json" | |
| - name: Setup problem matchers for PHPUnit | |
| run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json" | |
| - name: Set git to use LF | |
| run: | | |
| git config --global core.autocrlf false | |
| git config --global core.eol lf | |
| - uses: actions/checkout@v4 | |
| - name: Get composer cache directory | |
| run: echo COMPOSER_CACHE="$(composer config cache-files-dir)" >> "$env:GITHUB_ENV" | |
| - name: Cache composer dependencies | |
| uses: actions/cache@v4 | |
| with: | |
| path: $COMPOSER_CACHE | |
| key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }} | |
| restore-keys: ${{ runner.os }}-composer- | |
| - name: Install Composer dependencies | |
| run: composer install --no-progress --prefer-dist --optimize-autoloader | |
| - name: Run unit tests | |
| run: vendor/bin/phpunit --no-coverage | |
| coverage: | |
| name: Code coverage | |
| runs-on: [ubuntu-latest] | |
| needs: [unit-tests-linux] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: coverage-data | |
| path: ${{ github.workspace }}/build | |
| - name: Codecov | |
| uses: codecov/codecov-action@v5 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| fail_ci_if_error: true | |
| verbose: true | |
| cleanup: | |
| name: Cleanup artifacts | |
| needs: [unit-tests-linux, coverage] | |
| runs-on: [ubuntu-latest] | |
| if: | | |
| always() && | |
| needs.coverage.result == 'success' || | |
| (needs.unit-tests-linux.result == 'success' && needs.coverage.result == 'skipped') | |
| steps: | |
| - uses: geekyeggo/delete-artifact@v5 | |
| with: | |
| name: coverage-data |