docs: add missing docs #2605
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: CI | |
| on: | |
| push: | |
| pull_request: | |
| schedule: | |
| - cron: '0 0 1,16 * *' | |
| jobs: | |
| tests: | |
| name: P:${{ matrix.php }}, S:${{ matrix.symfony }}, D:${{ matrix.database }}, PU:${{ matrix.phpunit }}${{ matrix.deps == 'lowest' && ' (lowest)' || '' }}${{ matrix.use-dama == 1 && contains(matrix.database, 'sql') && ' (dama)' || '' }}${{ !contains(matrix.database, 'sql') && '' || matrix.use-migrate == 1 && ' (migrate)' || ' (schema)' }} | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| php: [ 8.1, 8.2, 8.3 ] | |
| deps: [ highest ] | |
| symfony: [ 6.4.*, 7.0.*, 7.1.* ] | |
| database: [ mysql, mongo ] | |
| use-dama: [ 1 ] | |
| use-migrate: [ 0 ] | |
| phpunit: [ 9 ] | |
| exclude: | |
| - php: 8.1 | |
| symfony: 7.0.* | |
| - php: 8.1 | |
| symfony: 7.1.* | |
| include: | |
| - php: 8.3 | |
| deps: highest | |
| symfony: '*' | |
| database: none | |
| use-dama: 1 | |
| use-migrate: 0 | |
| phpunit: 9 | |
| - php: 8.3 | |
| deps: highest | |
| symfony: '*' | |
| database: mysql|mongo | |
| use-dama: 1 | |
| use-migrate: 0 | |
| phpunit: 9 | |
| - php: 8.3 | |
| deps: highest | |
| symfony: '*' | |
| database: pgsql|mongo | |
| use-dama: 1 | |
| use-migrate: 0 | |
| phpunit: 9 | |
| - php: 8.3 | |
| deps: highest | |
| symfony: '*' | |
| database: pgsql | |
| use-dama: 0 | |
| use-migrate: 0 | |
| phpunit: 9 | |
| - php: 8.3 | |
| deps: highest | |
| symfony: '*' | |
| database: sqlite | |
| use-dama: 0 | |
| use-migrate: 0 | |
| phpunit: 9 | |
| - php: 8.3 | |
| deps: lowest | |
| symfony: '*' | |
| database: sqlite | |
| use-dama: 0 | |
| use-migrate: 0 | |
| phpunit: 9 | |
| - php: 8.3 | |
| deps: lowest | |
| symfony: '*' | |
| database: mysql | |
| use-dama: 1 | |
| use-migrate: 0 | |
| phpunit: 9 | |
| - php: 8.3 | |
| deps: highest | |
| symfony: '*' | |
| database: mysql | |
| use-dama: 1 | |
| use-migrate: 1 | |
| phpunit: 9 | |
| - php: 8.3 | |
| deps: highest | |
| symfony: '*' | |
| database: mysql|mongo | |
| use-dama: 1 | |
| use-migrate: 0 | |
| phpunit: 10 | |
| - php: 8.3 | |
| deps: highest | |
| symfony: '*' | |
| database: mysql|mongo | |
| use-dama: 1 | |
| use-migrate: 0 | |
| phpunit: 11 | |
| env: | |
| DATABASE_URL: ${{ contains(matrix.database, 'mysql') && 'mysql://root:root@localhost:3306/foundry?serverVersion=5.7.42' || contains(matrix.database, 'pgsql') && 'postgresql://root:root@localhost:5432/foundry?serverVersion=15' || contains(matrix.database, 'sqlite') && 'sqlite:///%kernel.project_dir%/var/data.db' || '' }} | |
| MONGO_URL: ${{ contains(matrix.database, 'mongo') && 'mongodb://127.0.0.1:27017/dbName?compressors=disabled&gssapiServiceName=mongodb' || '' }} | |
| USE_DAMA_DOCTRINE_TEST_BUNDLE: ${{ matrix.use-dama == 1 && contains(matrix.database, 'sql') && 1 || 0 }} | |
| PHPUNIT_VERSION: ${{ matrix.phpunit }} | |
| services: | |
| postgres: | |
| image: ${{ contains(matrix.database, 'pgsql') && 'postgres:15' || '' }} | |
| env: | |
| POSTGRES_USER: root | |
| POSTGRES_PASSWORD: root | |
| POSTGRES_DB: foundry | |
| ports: | |
| - 5432:5432 | |
| options: >- | |
| --health-cmd pg_isready | |
| --health-interval 10s | |
| --health-timeout 5s | |
| --health-retries 5 | |
| mongo: | |
| image: ${{ contains(matrix.database, 'mongo') && 'mongo:4' || '' }} | |
| ports: | |
| - 27017:27017 | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v3 | |
| - name: Setup PHP | |
| uses: shivammathur/setup-php@v2 | |
| with: | |
| php-version: ${{ matrix.php }} | |
| coverage: none | |
| tools: flex | |
| - name: Install dependencies | |
| uses: ramsey/composer-install@v2 | |
| with: | |
| dependency-versions: ${{ matrix.deps }} | |
| composer-options: --prefer-dist | |
| env: | |
| SYMFONY_REQUIRE: ${{ matrix.symfony }} | |
| - name: Set up MySQL | |
| if: contains(matrix.database, 'mysql') | |
| run: sudo /etc/init.d/mysql start | |
| - name: Test | |
| run: ./phpunit | |
| shell: bash | |
| env: | |
| DATABASE_RESET_MODE: ${{ matrix.use-migrate == 1 && 'migrate' || 'schema' }} | |
| code-coverage: | |
| name: Code Coverage | |
| runs-on: ubuntu-latest | |
| env: | |
| DATABASE_URL: postgresql://root:root@localhost:5432/foundry?serverVersion=15 | |
| MONGO_URL: mongodb://127.0.0.1:27017/dbName?compressors=disabled&gssapiServiceName=mongodb | |
| USE_DAMA_DOCTRINE_TEST_BUNDLE: 1 | |
| PHPUNIT_VERSION: 9 | |
| services: | |
| mongo: | |
| image: mongo:4 | |
| ports: | |
| - 27017:27017 | |
| postgres: | |
| image: postgres:15 | |
| env: | |
| POSTGRES_USER: root | |
| POSTGRES_PASSWORD: root | |
| POSTGRES_DB: foundry | |
| ports: | |
| - 5432:5432 | |
| options: >- | |
| --health-cmd pg_isready | |
| --health-interval 10s | |
| --health-timeout 5s | |
| --health-retries 5 | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v3 | |
| - name: Setup PHP | |
| uses: shivammathur/setup-php@v2 | |
| with: | |
| php-version: 8.2 | |
| coverage: xdebug | |
| ini-values: xdebug.mode=coverage | |
| - name: Install dependencies | |
| uses: ramsey/composer-install@v2 | |
| with: | |
| composer-options: --prefer-dist | |
| - name: Test with coverage | |
| run: ./phpunit --coverage-text --coverage-clover coverage.xml | |
| shell: bash | |
| env: | |
| SYMFONY_DEPRECATIONS_HELPER: disabled | |
| - name: Publish coverage report to Codecov | |
| uses: codecov/codecov-action@v3 | |
| with: | |
| file: ./coverage.xml | |
| composer-validate: | |
| uses: zenstruck/.github/.github/workflows/php-composer-validate.yml@main | |
| lint-docs: | |
| name: Lint Documentation | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: "Checkout code" | |
| uses: actions/checkout@v3 | |
| - name: DOCtor-RST | |
| uses: docker://oskarstark/doctor-rst | |
| with: | |
| args: --short --error-format=github | |
| env: | |
| DOCS_DIR: 'docs/' | |
| static-analysis: | |
| name: Static Analysis | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v3 | |
| - name: Setup PHP | |
| uses: shivammathur/setup-php@v2 | |
| with: | |
| php-version: 8.3 | |
| coverage: none | |
| - name: Install dependencies | |
| uses: ramsey/composer-install@v2 | |
| with: | |
| composer-options: --prefer-dist | |
| - name: Install PHPStan | |
| run: composer bin phpstan install | |
| - name: Run static analysis | |
| run: bin/tools/phpstan/vendor/phpstan/phpstan/phpstan analyse | |
| - name: Install Psalm | |
| run: composer bin psalm install | |
| - name: Run Psalm on factories generated with maker | |
| run: bin/tools/psalm/vendor/vimeo/psalm/psalm | |
| fixcs: | |
| name: Run php-cs-fixer | |
| needs: sync-with-template | |
| if: (github.event_name == 'push' || github.event_name == 'schedule') && !startsWith(github.ref, 'refs/tags') && github.repository_owner == 'zenstruck' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: zenstruck/.github/actions/php-cs-fixer@main | |
| with: | |
| php: 8 | |
| key: ${{ secrets.GPG_PRIVATE_KEY }} | |
| token: ${{ secrets.COMPOSER_TOKEN }} | |
| sync-with-template: | |
| name: Sync meta files | |
| if: (github.event_name == 'push' || github.event_name == 'schedule') && !startsWith(github.ref, 'refs/tags') && github.repository_owner == 'zenstruck' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: zenstruck/.github/actions/sync-with-template@main | |
| with: | |
| key: ${{ secrets.GPG_PRIVATE_KEY }} | |
| token: ${{ secrets.COMPOSER_TOKEN }} |