Lint (Docs) #123611
This file contains hidden or 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 }} | |
| new_docs_content: ${{ steps.changes.outputs.new_docs_content }} | |
| new_docs_content_files: ${{ steps.changes.outputs.new_docs_content_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/**' | |
| new_docs_content: | |
| - added|modified: 'docs/pages/**/*.mdx' | |
| 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: Check out teleport | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: 'gravitational/teleport' | |
| path: 'teleport' | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: 'gravitational/docs-website' | |
| path: 'docs' | |
| - name: Generate GitHub Token | |
| id: generate_token | |
| uses: actions/create-github-app-token@v2 | |
| with: | |
| app-id: ${{ secrets.REVIEWERS_APP_ID }} | |
| private-key: ${{ secrets.REVIEWERS_PRIVATE_KEY }} | |
| - name: Check out shared-workflows | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: gravitational/shared-workflows | |
| path: shared-workflows | |
| ref: 6f388765b8ce993721502083c74cb9af1fc5658f | |
| - name: Install Go | |
| uses: actions/setup-go@v5 | |
| with: | |
| go-version: 'stable' | |
| - name: Ensure docs changes include redirects | |
| env: | |
| TOKEN: ${{ steps.generate_token.outputs.token }} | |
| REVIEWERS: ${{ secrets.reviewers }} | |
| run: cd shared-workflows/bot && go run main.go -workflow=docpaths -token="${TOKEN}" -teleport-path="${GITHUB_WORKSPACE}/teleport" -reviewers="${REVIEWERS}" | |
| # 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 delete the three submodules we use for building the | |
| # live docs site and copy a gravitational/teleport clone into the | |
| # content directory. | |
| # | |
| # 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. | |
| # | |
| # We also replace data fetched from Sanity CMS with hardcoded JSON | |
| # objects to remove the need to authenticate with Sanity. Each includes | |
| # the minimal set of data required for docs builds to succeed. | |
| run: | | |
| echo "" > .gitmodules | |
| rm -rf content/* | |
| # Rather than using a submodule, copy the teleport source into the | |
| # content directory. | |
| cp -r "$GITHUB_WORKSPACE/teleport" "$GITHUB_WORKSPACE/docs/content/current" | |
| jq -nr --arg version "current" '{"versions": [{"name": $version,"branch": $version,"deprecated": false,"isDefault": true}]}' > config.json | |
| NEW_PACKAGE_JSON=$(jq '.scripts."git-update" = "echo Skipping submodule update"' package.json); | |
| NEW_PACKAGE_JSON=$(jq '.scripts."prepare-sanity-data" = "echo Using pre-populated Sanity data"' <<< "$NEW_PACKAGE_JSON"); | |
| echo "$NEW_PACKAGE_JSON" > package.json; | |
| echo "{}" > data/events.json | |
| echo '{"bannerButtons":{"second":{"title":"LOG IN","url":"https://teleport.sh"},"first":{"title":"Support","url":"https://goteleport.com/support/"}},"navbarData":{"rightSide":{},"logo":"/favicon.svg","menu":[]}}' > data/navbar.json | |
| - name: Check spelling | |
| working-directory: 'docs' | |
| run: yarn spellcheck content/current | |
| - name: Lint docs formatting | |
| working-directory: 'docs' | |
| run: yarn markdown-lint | |
| - name: Download vale | |
| env: | |
| GH_TOKEN: ${{ github.token }} | |
| VALE_VERSION: 3.12.0 | |
| # The sha256 checksum must be changed based on the downloaded package | |
| # when you update the Vale version. | |
| VALE_SHA256SUM: 3f4ea05cd1f2291b660ecf11a77cbb6b544b0f3b780604ad183f63285611321b | |
| run: | | |
| VALE_FILENAME="vale_${VALE_VERSION}_Linux_64-bit.tar.gz" | |
| gh release download "v${VALE_VERSION}" --repo="errata-ai/vale" --pattern="${VALE_FILENAME}" | |
| sha256sum --check <<<"${VALE_SHA256SUM} ${VALE_FILENAME}" | |
| tar -xvf "vale_${VALE_VERSION}_Linux_64-bit.tar.gz" | |
| - name: Check docs style | |
| working-directory: 'docs/content/current' | |
| run: | | |
| echo "Running Vale style checks. For information about ignoring Vale rules using comments, see: https://vale.sh/docs/formats/mdx#comments" | |
| "${GITHUB_WORKSPACE}/vale" --config docs/.vale.ini docs/pages | |
| - name: Test the docs build | |
| working-directory: docs | |
| run: yarn build |