[JsonEncoder] Add component documentation #22843
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: | |
| branches-ignore: | |
| - 'github-comments' | |
| pull_request: | |
| branches-ignore: | |
| - 'github-comments' | |
| permissions: | |
| contents: read | |
| jobs: | |
| symfony-docs-builder-build: | |
| name: Build (symfony-tools/docs-builder) | |
| runs-on: ubuntu-latest | |
| continue-on-error: true | |
| steps: | |
| - name: "Checkout" | |
| uses: actions/checkout@v4 | |
| - name: "Set-up PHP" | |
| uses: shivammathur/setup-php@v2 | |
| with: | |
| php-version: 8.2 | |
| coverage: none | |
| tools: "composer:v2" | |
| - name: Get composer cache directory | |
| id: composercache | |
| working-directory: _build | |
| run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT | |
| - name: Cache dependencies | |
| uses: actions/cache@v3 | |
| with: | |
| path: ${{ steps.composercache.outputs.dir }} | |
| key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }} | |
| restore-keys: ${{ runner.os }}-composer- | |
| - name: "Install dependencies" | |
| working-directory: _build | |
| run: composer install --prefer-dist --no-progress | |
| - name: "Build the docs" | |
| working-directory: _build | |
| run: php build.php --disable-cache | |
| doctor-rst: | |
| name: Lint (DOCtor-RST) | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: "Checkout" | |
| uses: actions/checkout@v4 | |
| - name: "Create cache dir" | |
| run: mkdir .cache | |
| - name: "Extract base branch name" | |
| run: echo "branch=$(echo ${GITHUB_BASE_REF:=${GITHUB_REF##*/}})" >> $GITHUB_OUTPUT | |
| id: extract_base_branch | |
| - name: "Cache DOCtor-RST" | |
| uses: actions/cache@v3 | |
| with: | |
| path: .cache | |
| key: ${{ runner.os }}-doctor-rst-${{ steps.extract_base_branch.outputs.branch }} | |
| - name: "Run DOCtor-RST" | |
| uses: docker://oskarstark/doctor-rst:1.64.0 | |
| with: | |
| args: --short --error-format=github --cache-file=/github/workspace/.cache/doctor-rst.cache | |
| symfony-code-block-checker: | |
| name: Code Blocks | |
| runs-on: ubuntu-latest | |
| continue-on-error: true | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| with: | |
| path: 'docs' | |
| - name: Set-up PHP | |
| uses: shivammathur/setup-php@v2 | |
| with: | |
| php-version: 8.2 | |
| coverage: none | |
| - name: Fetch branch from where the PR started | |
| working-directory: docs | |
| run: git fetch --no-tags --prune --depth=1 origin +refs/heads/*:refs/remotes/origin/* | |
| - name: Find modified files | |
| id: find-files | |
| working-directory: docs | |
| run: echo "files=$(git diff --name-only origin/${{ github.base_ref }} HEAD | grep ".rst" | tr '\n' ' ')" >> $GITHUB_OUTPUT | |
| - name: Get composer cache directory | |
| id: composercache | |
| working-directory: docs/_build | |
| run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT | |
| - name: Cache dependencies | |
| if: ${{ steps.find-files.outputs.files }} | |
| uses: actions/cache@v3 | |
| with: | |
| path: ${{ steps.composercache.outputs.dir }} | |
| key: ${{ runner.os }}-composer-codeBlocks-${{ hashFiles('_checker/composer.lock', '_sf_app/composer.lock') }} | |
| restore-keys: ${{ runner.os }}-composer-codeBlocks- | |
| - name: Install dependencies | |
| if: ${{ steps.find-files.outputs.files }} | |
| run: composer create-project symfony-tools/code-block-checker:@dev _checker | |
| - name: Install test application | |
| if: ${{ steps.find-files.outputs.files }} | |
| run: | | |
| git clone -b ${{ github.base_ref }} --depth 5 --single-branch https://github.com/symfony-tools/symfony-application.git _sf_app | |
| cd _sf_app | |
| composer update | |
| - name: Generate baseline | |
| if: ${{ steps.find-files.outputs.files }} | |
| working-directory: docs | |
| run: | | |
| CURRENT=$(git rev-parse HEAD) | |
| git checkout -m ${{ github.base_ref }} | |
| ../_checker/code-block-checker.php verify:docs `pwd` ${{ steps.find-files.outputs.files }} --generate-baseline=baseline.json --symfony-application=`realpath ../_sf_app` | |
| git checkout -m $CURRENT | |
| cat baseline.json | |
| - name: Verify examples | |
| if: ${{ steps.find-files.outputs.files }} | |
| working-directory: docs | |
| run: | | |
| ../_checker/code-block-checker.php verify:docs `pwd` ${{ steps.find-files.outputs.files }} --baseline=baseline.json --output-format=github --symfony-application=`realpath ../_sf_app` |