This repository was archived by the owner on Dec 9, 2025. It is now read-only.
docs: convert to archive style (#8) #31
This file contains hidden or 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: "build" | |
| on: | |
| pull_request: | |
| paths-ignore: | |
| - ".docs/**" | |
| push: | |
| branches: | |
| - "*" | |
| schedule: | |
| - cron: "0 8 * * 1" # At 08:00 on Monday | |
| env: | |
| extensions: "json" | |
| cache-version: "1" | |
| composer-version: "v1" | |
| composer-install: "composer update --no-interaction --no-progress --no-suggest --prefer-dist --prefer-stable" | |
| jobs: | |
| qa: | |
| name: "Quality assurance" | |
| runs-on: "${{ matrix.operating-system }}" | |
| strategy: | |
| matrix: | |
| php-version: [ "7.4" ] | |
| operating-system: [ "ubuntu-latest" ] | |
| fail-fast: false | |
| steps: | |
| - name: "Checkout" | |
| uses: "actions/checkout@v2" | |
| - name: "Setup PHP cache environment" | |
| id: "extcache" | |
| uses: "shivammathur/cache-extensions@v1" | |
| with: | |
| php-version: "${{ matrix.php-version }}" | |
| extensions: "${{ env.extensions }}" | |
| key: "${{ env.cache-version }}" | |
| - name: "Cache PHP extensions" | |
| uses: "actions/cache@v2" | |
| with: | |
| path: "${{ steps.extcache.outputs.dir }}" | |
| key: "${{ steps.extcache.outputs.key }}" | |
| restore-keys: "${{ steps.extcache.outputs.key }}" | |
| - name: "Install PHP" | |
| uses: "shivammathur/setup-php@v2" | |
| with: | |
| php-version: "${{ matrix.php-version }}" | |
| extensions: "${{ env.extensions }}" | |
| tools: "composer:${{ env.composer-version }} " | |
| - name: "Setup problem matchers for PHP" | |
| run: 'echo "::add-matcher::${{ runner.tool_cache }}/php.json"' | |
| - name: "Get Composer cache directory" | |
| id: "composercache" | |
| run: 'echo "::set-output name=dir::$(composer config cache-files-dir)"' | |
| - name: "Cache PHP dependencies" | |
| uses: "actions/cache@v2" | |
| with: | |
| path: "${{ steps.composercache.outputs.dir }}" | |
| key: "${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}" | |
| restore-keys: "${{ runner.os }}-composer-" | |
| - name: "Validate Composer" | |
| run: "composer validate" | |
| - name: "Install dependencies" | |
| run: "${{ env.composer-install }}" | |
| - name: "Quality assurance" | |
| run: "make qa" | |
| static-analysis: | |
| name: "Static analysis" | |
| runs-on: "${{ matrix.operating-system }}" | |
| strategy: | |
| matrix: | |
| php-version: [ "7.4" ] | |
| operating-system: [ "ubuntu-latest" ] | |
| fail-fast: false | |
| steps: | |
| - name: "Checkout" | |
| uses: "actions/checkout@v2" | |
| - name: "Setup PHP cache environment" | |
| id: "extcache" | |
| uses: "shivammathur/cache-extensions@v1" | |
| with: | |
| php-version: "${{ matrix.php-version }}" | |
| extensions: "${{ env.extensions }}" | |
| key: "${{ env.cache-version }}" | |
| - name: "Cache PHP extensions" | |
| uses: "actions/cache@v2" | |
| with: | |
| path: "${{ steps.extcache.outputs.dir }}" | |
| key: "${{ steps.extcache.outputs.key }}" | |
| restore-keys: "${{ steps.extcache.outputs.key }}" | |
| - name: "Install PHP" | |
| uses: "shivammathur/setup-php@v2" | |
| with: | |
| php-version: "${{ matrix.php-version }}" | |
| extensions: "${{ env.extensions }}" | |
| tools: "composer:${{ env.composer-version }} " | |
| - name: "Setup problem matchers for PHP" | |
| run: 'echo "::add-matcher::${{ runner.tool_cache }}/php.json"' | |
| - name: "Get Composer cache directory" | |
| id: "composercache" | |
| run: 'echo "::set-output name=dir::$(composer config cache-files-dir)"' | |
| - name: "Cache PHP dependencies" | |
| uses: "actions/cache@v2" | |
| with: | |
| path: "${{ steps.composercache.outputs.dir }}" | |
| key: "${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}" | |
| restore-keys: "${{ runner.os }}-composer-" | |
| - name: "Install dependencies" | |
| run: "${{ env.composer-install }}" | |
| - name: "PHPStan" | |
| run: "make phpstan" | |
| continue-on-error: true | |
| tests: | |
| name: "Tests" | |
| runs-on: "${{ matrix.operating-system }}" | |
| strategy: | |
| matrix: | |
| php-version: [ "7.2","7.3","7.4","8.0" ] | |
| operating-system: [ "ubuntu-latest" ] | |
| composer-args: [ "" ] | |
| include: | |
| - php-version: "7.2" | |
| operating-system: "ubuntu-latest" | |
| composer-args: "--prefer-lowest" | |
| fail-fast: false | |
| steps: | |
| - name: "Checkout" | |
| uses: "actions/checkout@v2" | |
| - name: "Setup PHP cache environment" | |
| id: "extcache" | |
| uses: "shivammathur/cache-extensions@v1" | |
| with: | |
| php-version: "${{ matrix.php-version }}" | |
| extensions: "${{ env.extensions }}" | |
| key: "${{ env.cache-version }}" | |
| - name: "Cache PHP extensions" | |
| uses: "actions/cache@v2" | |
| with: | |
| path: "${{ steps.extcache.outputs.dir }}" | |
| key: "${{ steps.extcache.outputs.key }}" | |
| restore-keys: "${{ steps.extcache.outputs.key }}" | |
| - name: "Install PHP" | |
| uses: "shivammathur/setup-php@v2" | |
| with: | |
| php-version: "${{ matrix.php-version }}" | |
| extensions: "${{ env.extensions }}" | |
| tools: "composer:${{ env.composer-version }} " | |
| - name: "Setup problem matchers for PHP" | |
| run: 'echo "::add-matcher::${{ runner.tool_cache }}/php.json"' | |
| - name: "Get Composer cache directory" | |
| id: "composercache" | |
| run: 'echo "::set-output name=dir::$(composer config cache-files-dir)"' | |
| - name: "Cache PHP dependencies" | |
| uses: "actions/cache@v2" | |
| with: | |
| path: "${{ steps.composercache.outputs.dir }}" | |
| key: "${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}" | |
| restore-keys: "${{ runner.os }}-composer-" | |
| - name: "Install dependencies" | |
| run: "${{ env.composer-install }} ${{ matrix.composer-args }}" | |
| - name: "Setup problem matchers for PHPUnit" | |
| run: 'echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"' | |
| - name: "Tests" | |
| run: "make tests" | |
| tests-code-coverage: | |
| name: "Tests with code coverage" | |
| runs-on: "${{ matrix.operating-system }}" | |
| strategy: | |
| matrix: | |
| php-version: [ "7.2" ] | |
| operating-system: [ "ubuntu-latest" ] | |
| fail-fast: false | |
| if: "github.event_name == 'push'" | |
| steps: | |
| - name: "Checkout" | |
| uses: "actions/checkout@v2" | |
| - name: "Setup PHP cache environment" | |
| id: "extcache" | |
| uses: "shivammathur/cache-extensions@v1" | |
| with: | |
| php-version: "${{ matrix.php-version }}" | |
| extensions: "${{ env.extensions }}" | |
| key: "${{ env.cache-version }}" | |
| - name: "Cache PHP extensions" | |
| uses: "actions/cache@v2" | |
| with: | |
| path: "${{ steps.extcache.outputs.dir }}" | |
| key: "${{ steps.extcache.outputs.key }}" | |
| restore-keys: "${{ steps.extcache.outputs.key }}" | |
| - name: "Install PHP" | |
| uses: "shivammathur/setup-php@v2" | |
| with: | |
| php-version: "${{ matrix.php-version }}" | |
| extensions: "${{ env.extensions }}" | |
| tools: "composer:${{ env.composer-version }} " | |
| - name: "Setup problem matchers for PHP" | |
| run: 'echo "::add-matcher::${{ runner.tool_cache }}/php.json"' | |
| - name: "Get Composer cache directory" | |
| id: "composercache" | |
| run: 'echo "::set-output name=dir::$(composer config cache-files-dir)"' | |
| - name: "Cache PHP dependencies" | |
| uses: "actions/cache@v2" | |
| with: | |
| path: "${{ steps.composercache.outputs.dir }}" | |
| key: "${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}" | |
| restore-keys: "${{ runner.os }}-composer-" | |
| - name: "Install dependencies" | |
| run: "${{ env.composer-install }}" | |
| - name: "Tests" | |
| run: "make coverage-clover" | |
| - name: "Coveralls.io" | |
| env: | |
| CI_NAME: github | |
| CI: true | |
| COVERALLS_REPO_TOKEN: "${{ secrets.GITHUB_TOKEN }}" | |
| run: | | |
| wget https://github.com/php-coveralls/php-coveralls/releases/download/v2.1.0/php-coveralls.phar | |
| php php-coveralls.phar --verbose --config tests/.coveralls.yml |