Lint (Docs) #82458
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: Lint (Docs) | |
| run-name: Lint (Docs) | |
| on: | |
| pull_request: | |
| merge_group: | |
| jobs: | |
| changes: | |
| name: Check for relevant changes | |
| runs-on: ubuntu-latest | |
| permissions: | |
| pull-requests: read | |
| outputs: | |
| changed: ${{ steps.changes.outputs.changed }} | |
| changed_files: ${{ steps.changes.outputs.changed_files }} | |
| steps: | |
| - name: Checkout | |
| if: ${{ github.event_name == 'merge_group' }} | |
| uses: actions/checkout@v4 | |
| - uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2 | |
| id: changes | |
| with: | |
| base: ${{ github.event.pull_request.base.ref || github.event.merge_group.base_ref }} | |
| ref: ${{ github.event.pull_request.head.ref || github.event.merge_group.head_ref }} | |
| list-files: csv | |
| filters: | | |
| changed: | |
| - '.github/workflows/doc-tests.yaml' | |
| - 'CHANGELOG.md' | |
| - 'docs/**' | |
| - 'examples/**' | |
| doc-tests: | |
| name: Lint (Docs) | |
| needs: changes | |
| if: ${{ !startsWith(github.head_ref, 'dependabot/') && needs.changes.outputs.changed == 'true' }} | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: 'gravitational/teleport' | |
| path: 'teleport' | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: 'gravitational/docs' | |
| path: 'docs' | |
| # Cache node_modules. Unlike the example in the actions/cache repo, this | |
| # caches the node_modules directory instead of the yarn cache. This is | |
| # because yarn needs to build fresh packages even when it copies files | |
| # from the yarn cache into node_modules. | |
| # See: | |
| # https://github.com/actions/cache/blob/main/examples.md#node---yarn | |
| - uses: actions/cache@v4 | |
| id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`) | |
| with: | |
| path: '${{ github.workspace }}/docs/node_modules' | |
| key: ${{ runner.os }}-yarn-${{ hashFiles(format('{0}/docs/yarn.lock', github.workspace)) }} | |
| restore-keys: | | |
| ${{ runner.os }}-yarn- | |
| - name: Install docs site dependencies | |
| working-directory: docs | |
| if: ${{ steps.yarn-cache.outputs.cache-hit != 'true' }} | |
| # Prevent occasional `yarn install` executions that run indefinitely | |
| timeout-minutes: 10 | |
| run: yarn install | |
| - name: Prepare docs site configuration | |
| working-directory: docs | |
| # The environment we use for linting the docs differs from the one we | |
| # use for the live docs site in that we only test a single version of | |
| # the content. | |
| # | |
| # To do this, we replace the three submodules we use for building the | |
| # live docs site with a single submodule, pointing to the | |
| # gravitational/teleport branch we are linting. | |
| # | |
| # The docs engine expects a config.json file at the root of the | |
| # gravitational/docs clone that associates directories with git | |
| # submodules. By default, these directories represent versioned branches | |
| # of gravitational/teleport. We override this in order to build only a | |
| # single version of the docs. | |
| run: | | |
| echo "" > .gitmodules | |
| rm -rf content/* | |
| cd content | |
| # Rather than using a submodule, copy the teleport source into the | |
| # content directory. | |
| cp -r $GITHUB_WORKSPACE/teleport $GITHUB_WORKSPACE/docs/content | |
| cd $GITHUB_WORKSPACE/docs | |
| echo "{\"versions\": [{\"name\": \"teleport\", \"branch\": \"teleport\", \"deprecated\": false}]}" > $GITHUB_WORKSPACE/docs/config.json | |
| cat <<< "$(jq '.scripts."git-update" = "echo Skipping submodule update"' package.json)" > package.json | |
| yarn build-node | |
| - name: Check spelling | |
| working-directory: 'docs' | |
| run: yarn spellcheck content/teleport | |
| - name: Lint docs formatting | |
| working-directory: 'docs' | |
| run: yarn markdown-lint | |
| - name: Test the docs build | |
| working-directory: docs | |
| run: yarn build | |
| stylecheck: | |
| name: Lint docs prose style | |
| runs-on: ubuntu-latest | |
| needs: changes | |
| if: ${{ !startsWith(github.head_ref, 'dependabot/') && needs.changes.outputs.changed == 'true' && github.event_name == 'pull_request' }} | |
| permissions: | |
| pull-requests: read | |
| steps: | |
| - name: Check out the teleport repo | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: "gravitational/teleport" | |
| - name: Run the linter | |
| uses: errata-ai/vale-action@d89dee975228ae261d22c15adcd03578634d429c # v2.1.1 | |
| with: | |
| version: 2.30.0 | |
| # Take the comma-separated list of files returned by the "Check for | |
| # relevant changes" job. | |
| separator: "," | |
| files: ${{ needs.changes.outputs.changed_files }} | |
| # Restrict the linter to lines modified/added by a PR, not entire | |
| # changed files. | |
| filter_mode: added | |
| fail_on_error: true | |
| vale_flags: "--config=docs/.vale.ini" | |