docs: update readme description #22
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
| --- | |
| on: # yamllint disable-line rule:truthy | |
| pull_request: | |
| branches: | |
| - master | |
| push: | |
| branches: | |
| - master | |
| name: 🔍 Continuous integration | |
| jobs: | |
| commit-linting: | |
| timeout-minutes: 4 | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| pull-requests: read | |
| steps: | |
| - name: 📦 Check out the codebase | |
| uses: actions/[email protected] | |
| - name: 🧐 Lint commits using "commitlint" | |
| uses: wagoid/[email protected] | |
| with: | |
| configFile: ${{ github.workspace }}/.github/.commitlint.config.mjs | |
| failOnWarnings: false | |
| failOnErrors: false | |
| helpURL: 'https://github.com/conventional-changelog/commitlint/#what-is-commitlint' | |
| markdown-linting: | |
| timeout-minutes: 4 | |
| runs-on: ubuntu-latest | |
| concurrency: | |
| cancel-in-progress: true | |
| group: markdown-linting-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| steps: | |
| - name: 📦 Check out the codebase | |
| uses: actions/[email protected] | |
| - name: 🧐 Lint Markdown files | |
| uses: DavidAnson/[email protected] | |
| with: | |
| globs: | | |
| **/*.md | |
| !CHANGELOG.md | |
| code-coverage: | |
| timeout-minutes: 4 | |
| runs-on: ${{ matrix.os }} | |
| concurrency: | |
| cancel-in-progress: true | |
| group: code-coverage-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| strategy: | |
| fail-fast: true | |
| matrix: | |
| os: | |
| - ubuntu-latest | |
| php-version: | |
| - '8.2' | |
| dependencies: | |
| - locked | |
| steps: | |
| - name: 📦 Check out the codebase | |
| uses: actions/[email protected] | |
| - name: 🛠️ Setup PHP | |
| uses: shivammathur/[email protected] | |
| with: | |
| php-version: ${{ matrix.php-version }} | |
| extensions: mbstring, pdo, pdo_sqlite | |
| ini-values: error_reporting=E_ALL | |
| coverage: xdebug | |
| - name: 🛠️ Setup problem matchers | |
| run: | | |
| echo "::add-matcher::${{ runner.tool_cache }}/php.json" | |
| echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json" | |
| - name: 🤖 Validate composer.json and composer.lock | |
| run: composer validate --ansi --strict | |
| - name: 🔍 Get composer cache directory | |
| uses: cycle/gh-actions/actions/composer/[email protected] | |
| - name: ♻️ Restore cached dependencies installed with composer | |
| uses: actions/[email protected] | |
| with: | |
| path: ${{ env.COMPOSER_CACHE_DIR }} | |
| key: php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-${{ hashFiles('composer.lock') }} | |
| restore-keys: php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}- | |
| - name: 📥 Install "${{ matrix.dependencies }}" dependencies | |
| uses: cycle/gh-actions/actions/composer/[email protected] | |
| with: | |
| dependencies: ${{ matrix.dependencies }} | |
| - name: 🧪 Collect code coverage with Xdebug and phpunit/phpunit | |
| run: composer test:cc | |
| - name: 📤 Upload code coverage report to Codecov | |
| uses: codecov/[email protected] | |
| with: | |
| files: .build/phpunit/logs/clover.xml | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| verbose: true | |
| coding-standards: | |
| timeout-minutes: 4 | |
| runs-on: ${{ matrix.os }} | |
| concurrency: | |
| cancel-in-progress: true | |
| group: coding-standards-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| strategy: | |
| fail-fast: true | |
| matrix: | |
| os: | |
| - ubuntu-latest | |
| php-version: | |
| - '8.2' | |
| dependencies: | |
| - locked | |
| steps: | |
| - name: 📦 Check out the codebase | |
| uses: actions/[email protected] | |
| - name: 🧐 Lint YAML files | |
| uses: ibiqlik/[email protected] | |
| with: | |
| config_file: .yamllint.yaml | |
| file_or_dir: '.' | |
| strict: true | |
| - name: 🛠️ Setup PHP | |
| uses: shivammathur/[email protected] | |
| with: | |
| php-version: ${{ matrix.php-version }} | |
| extensions: mbstring, pdo, pdo_sqlite | |
| ini-values: error_reporting=E_ALL | |
| coverage: xdebug | |
| - name: 🛠️ Setup problem matchers | |
| run: | | |
| echo "::add-matcher::${{ runner.tool_cache }}/php.json" | |
| - name: 🤖 Validate composer.json and composer.lock | |
| run: composer validate --ansi --strict | |
| - name: 🔍 Get composer cache directory | |
| uses: cycle/gh-actions/actions/composer/[email protected] | |
| - name: ♻️ Restore cached dependencies installed with composer | |
| uses: actions/[email protected] | |
| with: | |
| path: ${{ env.COMPOSER_CACHE_DIR }} | |
| key: php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-${{ hashFiles('composer.lock') }} | |
| restore-keys: php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}- | |
| - name: 📥 Install "${{ matrix.dependencies }}" dependencies | |
| uses: cycle/gh-actions/actions/composer/[email protected] | |
| with: | |
| dependencies: ${{ matrix.dependencies }} | |
| - name: 🛠️ Prepare environment | |
| run: make prepare | |
| - name: 🚨 Run coding standards task | |
| run: composer cs:diff | |
| env: | |
| PHP_CS_FIXER_IGNORE_ENV: true | |
| dependency-analysis: | |
| timeout-minutes: 4 | |
| runs-on: ${{ matrix.os }} | |
| concurrency: | |
| cancel-in-progress: true | |
| group: dependency-analysis-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| strategy: | |
| fail-fast: true | |
| matrix: | |
| os: | |
| - ubuntu-latest | |
| php-version: | |
| - '8.2' | |
| dependencies: | |
| - locked | |
| steps: | |
| - name: 📦 Check out the codebase | |
| uses: actions/[email protected] | |
| - name: 🛠️ Setup PHP | |
| uses: shivammathur/[email protected] | |
| with: | |
| php-version: ${{ matrix.php-version }} | |
| extensions: mbstring, json, curl, dom, xml, phar | |
| ini-values: error_reporting=E_ALL | |
| coverage: none | |
| tools: phive | |
| - name: 🛠️ Setup problem matchers | |
| run: echo "::add-matcher::${{ runner.tool_cache }}/php.json" | |
| - name: 🤖 Validate composer.json and composer.lock | |
| run: composer validate --ansi --strict | |
| - name: 🔍 Get composer cache directory | |
| uses: wayofdev/gh-actions/actions/composer/[email protected] | |
| - name: ♻️ Restore cached dependencies installed with composer | |
| uses: actions/[email protected] | |
| with: | |
| path: ${{ env.COMPOSER_CACHE_DIR }} | |
| key: php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-${{ hashFiles('composer.lock') }} | |
| restore-keys: php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}- | |
| - name: 📥 Install "${{ matrix.dependencies }}" dependencies | |
| uses: wayofdev/gh-actions/actions/composer/[email protected] | |
| with: | |
| dependencies: ${{ matrix.dependencies }} | |
| - name: 📥 Install dependencies with phive | |
| uses: wayofdev/gh-actions/actions/phive/[email protected] | |
| with: | |
| phive-home: '.phive' | |
| trust-gpg-keys: '0x033E5F8D801A2F8D' | |
| - name: 🔬 Run maglnet/composer-require-checker | |
| run: .phive/composer-require-checker check --ansi --config-file="$(pwd)/composer-require-checker.json" --verbose | |
| mutation-testing: | |
| timeout-minutes: 16 | |
| runs-on: ${{ matrix.os }} | |
| concurrency: | |
| cancel-in-progress: true | |
| group: mutation-testing-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| strategy: | |
| fail-fast: true | |
| matrix: | |
| os: | |
| - ubuntu-latest | |
| php-version: | |
| - '8.2' | |
| dependencies: | |
| - locked | |
| steps: | |
| - name: 📦 Check out the codebase | |
| uses: actions/[email protected] | |
| - name: 🛠️ Setup PHP | |
| uses: shivammathur/[email protected] | |
| with: | |
| php-version: ${{ matrix.php-version }} | |
| extensions: mbstring, pdo, pdo_sqlite | |
| ini-values: error_reporting=E_ALL | |
| coverage: xdebug | |
| - name: 🛠️ Setup problem matchers | |
| run: echo "::add-matcher::${{ runner.tool_cache }}/php.json" | |
| - name: 🤖 Validate composer.json and composer.lock | |
| run: composer validate --ansi --strict | |
| - name: 🔍 Get composer cache directory | |
| uses: wayofdev/gh-actions/actions/composer/[email protected] | |
| - name: ♻️ Restore cached dependencies installed with composer | |
| uses: actions/[email protected] | |
| with: | |
| path: ${{ env.COMPOSER_CACHE_DIR }} | |
| key: php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-${{ hashFiles('composer.lock') }} | |
| restore-keys: php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}- | |
| - name: 📥 Install "${{ matrix.dependencies }}" dependencies | |
| uses: wayofdev/gh-actions/actions/composer/[email protected] | |
| with: | |
| dependencies: ${{ matrix.dependencies }} | |
| - name: 🧪 Run mutation testing using Xdebug and infection/infection | |
| run: composer infect:ci | |
| env: | |
| STRYKER_DASHBOARD_API_KEY: ${{ secrets.STRYKER_DASHBOARD_API_KEY }} | |
| security-analysis: | |
| timeout-minutes: 4 | |
| runs-on: ${{ matrix.os }} | |
| concurrency: | |
| cancel-in-progress: true | |
| group: security-analysis-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| strategy: | |
| fail-fast: true | |
| matrix: | |
| os: | |
| - ubuntu-latest | |
| php-version: | |
| - '8.2' | |
| dependencies: | |
| - locked | |
| steps: | |
| - name: 📦 Check out the codebase | |
| uses: actions/[email protected] | |
| - name: 🛠️ Setup PHP | |
| uses: shivammathur/[email protected] | |
| with: | |
| php-version: ${{ matrix.php-version }} | |
| extensions: mbstring, pdo, pdo_sqlite | |
| ini-values: error_reporting=E_ALL | |
| coverage: none | |
| - name: 🛠️ Setup problem matchers | |
| run: echo "::add-matcher::${{ runner.tool_cache }}/php.json" | |
| - name: 🤖 Validate composer.json and composer.lock | |
| run: composer validate --ansi --strict | |
| - name: 🔍 Get composer cache directory | |
| uses: wayofdev/gh-actions/actions/composer/[email protected] | |
| - name: ♻️ Restore cached dependencies installed with composer | |
| uses: actions/[email protected] | |
| with: | |
| path: ${{ env.COMPOSER_CACHE_DIR }} | |
| key: php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-${{ hashFiles('composer.lock') }} | |
| restore-keys: php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}- | |
| - name: 📥 Install "${{ matrix.dependencies }}" dependencies | |
| uses: wayofdev/gh-actions/actions/composer/[email protected] | |
| with: | |
| dependencies: ${{ matrix.dependencies }} | |
| - name: 🐛 Check installed packages for security vulnerability advisories | |
| run: composer audit --ansi | |
| static-analysis: | |
| timeout-minutes: 4 | |
| runs-on: ${{ matrix.os }} | |
| concurrency: | |
| cancel-in-progress: true | |
| group: static-analysis-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| strategy: | |
| fail-fast: true | |
| matrix: | |
| os: | |
| - ubuntu-latest | |
| php-version: | |
| - '8.2' | |
| dependencies: | |
| - locked | |
| steps: | |
| - name: 📦 Check out the codebase | |
| uses: actions/[email protected] | |
| - name: 🛠️ Setup PHP | |
| uses: shivammathur/[email protected] | |
| with: | |
| php-version: ${{ matrix.php-version }} | |
| extensions: mbstring, pdo, pdo_sqlite | |
| ini-values: error_reporting=E_ALL | |
| coverage: none | |
| - name: 🛠️ Setup problem matchers | |
| run: echo "::add-matcher::${{ runner.tool_cache }}/php.json" | |
| - name: 🤖 Validate composer.json and composer.lock | |
| run: composer validate --ansi --strict | |
| - name: 🔍 Get composer cache directory | |
| uses: wayofdev/gh-actions/actions/composer/[email protected] | |
| - name: ♻️ Restore cached dependencies installed with composer | |
| uses: actions/[email protected] | |
| with: | |
| path: ${{ env.COMPOSER_CACHE_DIR }} | |
| key: php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-${{ hashFiles('composer.lock') }} | |
| restore-keys: php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}- | |
| - name: 📥 Install "${{ matrix.dependencies }}" dependencies | |
| uses: wayofdev/gh-actions/actions/composer/[email protected] | |
| with: | |
| dependencies: ${{ matrix.dependencies }} | |
| - name: 🔍 Run static analysis using phpstan | |
| run: composer stan:ci | |
| - name: 🔍 Run static analysis using psalm | |
| run: composer psalm:ci |