chore(docs): update Swagger Aggregator documentation #14751
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: Build and deploy documentation | |
| on: | |
| push: | |
| branches: | |
| - "main" | |
| - "preview" | |
| - "prod" | |
| tags: | |
| - "*" | |
| pull_request: | |
| branches: | |
| - "main" | |
| - "preview" | |
| - "prod" | |
| jobs: | |
| install: | |
| name: Install and verify contents | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Setup Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: 18 | |
| cache: "yarn" | |
| - name: Cache Node Modules | |
| id: cache-node-modules | |
| uses: actions/cache@v4 | |
| with: | |
| path: node_modules | |
| key: node-modules-${{ hashFiles('yarn.lock') }} | |
| - name: Install | |
| if: steps.cache.outputs.cache-hit != 'true' | |
| run: yarn | |
| - name: Check lint | |
| run: yarn lint | |
| - name: Check spell | |
| run: yarn spellcheck | |
| - name: Check content | |
| run: yarn check-content | |
| - name: Verify build | |
| env: | |
| NODE_OPTIONS: "--max_old_space_size=4096" | |
| run: yarn build | |
| if: github.event_name == 'pull_request' | |
| build: | |
| needs: install | |
| name: Build docker image | |
| if: github.event_name != 'pull_request' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Cache Node Modules | |
| id: cache-node-modules | |
| uses: actions/cache@v4 | |
| with: | |
| path: node_modules | |
| key: node-modules-${{ hashFiles('yarn.lock') }} | |
| - name: Build site | |
| env: | |
| NODE_ENV: "production" | |
| INLINE_RUNTIME_CHUNK: "false" | |
| NODE_OPTIONS: "--max_old_space_size=4096" | |
| run: yarn build | |
| - name: Configure docker metadata | |
| id: meta | |
| uses: docker/metadata-action@v5 | |
| with: | |
| images: | | |
| ghcr.io/mia-platform/documentation | |
| tags: | | |
| type=ref,event=branch | |
| type=semver,pattern={{version}} | |
| type=semver,pattern={{major}}.{{minor}} | |
| type=semver,pattern={{major}} | |
| labels: | | |
| org.opencontainers.image.documentation=https://mia-platform.eu | |
| org.opencontainers.image.vendor=Mia-Platform | |
| - name: Set up Docker Buildx | |
| uses: docker/setup-buildx-action@v3 | |
| - name: Docker Login to ghcr.io | |
| uses: docker/login-action@v3 | |
| with: | |
| registry: ghcr.io | |
| username: ${{ github.repository_owner }} | |
| password: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Prepare build cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: /tmp/.buildx-cache | |
| key: ${{ runner.os }}-buildx-${{ github.sha }}-${{ hashFiles('nginx/permanent.redirects') }} | |
| restore-keys: | | |
| ${{ runner.os }}-buildx- | |
| - name: Build and push | |
| uses: docker/build-push-action@v6 | |
| with: | |
| context: . | |
| push: true | |
| tags: ${{ steps.meta.outputs.tags }} | |
| labels: ${{ steps.meta.outputs.labels }} | |
| cache-from: type=local,src=/tmp/.buildx-cache | |
| cache-to: type=local,dest=/tmp/.buildx-cache | |
| build-args: | | |
| BUILDTIME=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.created'] }} | |
| VERSION=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.version'] }} | |
| deploy: | |
| name: Deploy documentation trigger | |
| needs: build | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: eic/trigger-gitlab-ci@v3 | |
| with: | |
| url: https://git.tools.mia-platform.eu | |
| project_id: ${{ vars.MIA_PLATFORM_DOCUMENTATION_GITLAB_PROJECT_ID }} | |
| token: ${{ secrets.MIA_PLATFORM_DOCUMENTATION_GITLAB_TOKEN }} | |
| variables: | | |
| ENVIRONMENT_TO_DEPLOY=PROD | |
| ref_name: master |