feat: Update OpenAPI implementation (#645) #1267
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: PHPDrafter tests | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| jobs: | |
| test: | |
| runs-on: ubuntu-latest | |
| name: PHP ${{ matrix.php-versions }} | |
| continue-on-error: ${{ matrix.experimental }} | |
| env: | |
| extensions: curl,json,mbstring,uopz | |
| key: cache-v1 # can be any string, change to clear the extension cache. | |
| strategy: | |
| matrix: | |
| php-versions: ['8.1', '8.2', '8.3'] | |
| experimental: [ false ] | |
| include: | |
| - php-versions: '8.4' | |
| experimental: true | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup cache environment | |
| id: extcache | |
| uses: shivammathur/cache-extensions@v1 | |
| with: | |
| php-version: ${{ matrix.php-versions }} | |
| 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 | |
| env: | |
| COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| with: | |
| php-version: ${{ matrix.php-versions }} | |
| extensions: ${{ env.extensions }} | |
| coverage: pcov | |
| tools: pecl,phpstan,phpunit,cs2pr,phpcs | |
| - name: Get Composer Cache Directory | |
| id: composer-cache | |
| run: echo "dir=$(composer config cache-files-dir)" >> "$GITHUB_OUTPUT" | |
| - name: Cache dependencies | |
| uses: actions/cache@v4 | |
| with: | |
| path: ${{ steps.composer-cache.outputs.dir }} | |
| key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }} | |
| restore-keys: ${{ runner.os }}-composer- | |
| - name: Validate composer.json and composer.lock | |
| run: composer validate | |
| - name: Install dependencies | |
| run: composer install --prefer-dist --no-progress --no-suggest --ignore-platform-reqs | |
| - name: Setup Problem Matchers for PHPUnit | |
| run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json" | |
| - name: Run test suite | |
| run: ./vendor/phpunit/phpunit/phpunit --configuration tests/phpunit.xml --coverage-clover=coverage.xml --exclude-group twig | |
| - name: PHPStan | |
| run: ./vendor/phpstan/phpstan/phpstan analyse --level=6 src/ | |
| - name: PHPCS | |
| run: phpcs --standard=tests/phpcs.xml --ignore=\*Minifier.php src/ | cs2pr | |
| - name: Upload coverage result | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: coverage-${{ matrix.php-versions }} | |
| path: coverage.xml | |
| openapi: | |
| name: File generation | |
| needs: test | |
| runs-on: ubuntu-latest | |
| env: | |
| PHPDRAFT_THIRD_PARTY: 1 | |
| extensions: curl,json,mbstring,uopz | |
| key: cache-v1 # can be any string, change to clear the extension cache. | |
| strategy: | |
| matrix: | |
| php-versions: [ '8.3' ] | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis | |
| - name: Setup cache environment | |
| id: extcache | |
| uses: shivammathur/cache-extensions@v1 | |
| with: | |
| php-version: ${{ matrix.php-versions }} | |
| 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-versions }} | |
| extensions: ${{ env.extensions }} | |
| coverage: pcov | |
| tools: pecl,phpunit | |
| - name: Get Composer Cache Directory | |
| id: composer-cache | |
| run: echo "dir=$(composer config cache-files-dir)" >> "$GITHUB_OUTPUT" | |
| - name: Cache dependencies | |
| uses: actions/cache@v4 | |
| with: | |
| path: ${{ steps.composer-cache.outputs.dir }} | |
| key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }} | |
| restore-keys: ${{ runner.os }}-composer- | |
| - name: Validate composer.json and composer.lock | |
| run: composer validate | |
| - name: Install dependencies | |
| run: composer install --prefer-dist --no-progress --ignore-platform-reqs | |
| - name: Generate OpenAPI definition and HTML | |
| run: php ./phpdraft --online --file tests/statics/full_test.apib --openapi openapi.json > out.html 2> error.txt || true | |
| - name: Install check-jsonschema | |
| run: pipx install check-jsonschema | |
| - name: Validate OpenAPI spec | |
| run: | | |
| if [ -s "error.txt" ]; then | |
| echo "The file 'error.txt' is not empty." | |
| cat error.txt | |
| exit 1 | |
| fi | |
| if [ ! -s "index.html" ]; then | |
| echo "The file 'index.html' is empty." | |
| exit 1 | |
| fi | |
| if [ ! -s "openapi.json" ]; then | |
| echo "The file 'openapi.json' is empty." | |
| exit 1 | |
| fi | |
| check-jsonschema --schemafile https://spec.openapis.org/oas/3.1/schema/latest openapi.json | |
| analytics: | |
| name: Analytics | |
| needs: test | |
| if: success() | |
| runs-on: ubuntu-latest | |
| env: | |
| extensions: curl,json,mbstring,uopz | |
| key: cache-v1 # can be any string, change to clear the extension cache. | |
| strategy: | |
| matrix: | |
| php-versions: ['8.3'] | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis | |
| - name: Setup cache environment | |
| id: extcache | |
| uses: shivammathur/cache-extensions@v1 | |
| with: | |
| php-version: ${{ matrix.php-versions }} | |
| 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-versions }} | |
| extensions: ${{ env.extensions }} | |
| coverage: pcov | |
| tools: pecl,phpunit | |
| - name: Get Composer Cache Directory | |
| id: composer-cache | |
| run: echo "dir=$(composer config cache-files-dir)" >> "$GITHUB_OUTPUT" | |
| - name: Cache dependencies | |
| uses: actions/cache@v4 | |
| with: | |
| path: ${{ steps.composer-cache.outputs.dir }} | |
| key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }} | |
| restore-keys: ${{ runner.os }}-composer- | |
| - name: Validate composer.json and composer.lock | |
| run: composer validate | |
| - name: Install dependencies | |
| run: composer install --prefer-dist --no-progress --no-suggest --ignore-platform-reqs | |
| - name: Run test suite | |
| run: ./vendor/phpunit/phpunit/phpunit --configuration tests/phpunit.xml --exclude-group twig --coverage-clover=./var/coverage/clover.xml | |
| - name: Code coverage Scan | |
| uses: codecov/codecov-action@v4 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| - name: Change paths in clover.xml | |
| run: | | |
| sed -i 's+/home/runner/work/bundle-stripe/bundle-stripe+/github/workspace+g' ./var/coverage/clover.xml | |
| mv ./var/coverage/clover.xml coverage.xml | |
| - name: SonarCloud Scan | |
| uses: sonarsource/[email protected] | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} |