Repo sync #42823
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: Test | |
| # **What it does**: Runs our tests. | |
| # **Why we have it**: We want our tests to pass before merging code. | |
| # **Who does it impact**: Docs engineering, open-source engineering contributors. | |
| on: | |
| workflow_dispatch: | |
| merge_group: | |
| pull_request: | |
| permissions: | |
| contents: read | |
| pull-requests: read | |
| # This allows a subsequently queued workflow run to interrupt previous runs | |
| concurrency: | |
| group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}' | |
| cancel-in-progress: true | |
| env: | |
| # Setting this will activate the vitest tests that depend on actually | |
| # sending real search queries to Elasticsearch | |
| ELASTICSEARCH_URL: http://localhost:9200/ | |
| jobs: | |
| test: | |
| name: ${{ matrix.name }} | |
| if: github.repository == 'github/docs-internal' || github.repository == 'github/docs' | |
| # Run on ubuntu-20.04-xl if the private repo or ubuntu-latest if the public repo | |
| # See pull # 17442 in the private repo for context | |
| runs-on: ${{ fromJSON('["ubuntu-latest", "ubuntu-20.04-xl"]')[github.repository == 'github/docs-internal'] }} | |
| timeout-minutes: 60 | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| # Note that *if you add* to this, remember to also add that | |
| # to the **required checks** in the branch protection rules. | |
| name: | |
| # src/ directory | |
| - archives | |
| - assets | |
| - audit-logs | |
| - automated-pipelines | |
| # - bookmarklets | |
| - changelogs | |
| # - codeql-cli | |
| - color-schemes | |
| - content-linter | |
| - content-render | |
| - data-directory | |
| # - dev-toc | |
| - early-access | |
| - events | |
| - fixtures | |
| - frame | |
| - ghes-releases | |
| - github-apps | |
| - graphql | |
| - landings | |
| - languages | |
| - learning-track | |
| # - links | |
| - observability | |
| # - open-source | |
| - pageinfo | |
| # - pages | |
| - products | |
| - redirects | |
| - release-notes | |
| - rest | |
| - search | |
| - shielding | |
| - tracking | |
| # - tests | |
| # - tools | |
| - versions | |
| - webhooks | |
| - workflows | |
| # The languages suite only runs on docs-internal | |
| isPrivateRepo: | |
| - ${{ github.repository == 'github/docs-internal' }} | |
| exclude: | |
| - name: languages | |
| isPrivateRepo: false | |
| steps: | |
| # Each of these ifs needs to be repeated at each step to make sure the required check still runs | |
| # Even if if doesn't do anything | |
| - name: Check out repo | |
| uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | |
| - uses: ./.github/actions/setup-elasticsearch | |
| if: ${{ matrix.name == 'search' || matrix.name == 'languages' }} | |
| - uses: ./.github/actions/node-npm-setup | |
| - uses: ./.github/actions/get-docs-early-access | |
| if: ${{ github.repository == 'github/docs-internal' }} | |
| with: | |
| token: ${{ secrets.DOCS_BOT_PAT_READPUBLICKEY }} | |
| - name: Check the test fixture data (if applicable) | |
| if: ${{ matrix.name == 'fixtures' }} | |
| run: npm run copy-fixture-data -- --check | |
| # This keeps our fixture content/data in check | |
| - name: Check the test fixture content (if applicable) | |
| if: ${{ matrix.name == 'fixtures' }} | |
| env: | |
| ROOT: src/fixtures/fixtures | |
| run: | | |
| # If either of these fail, it means our fixture content's internal | |
| # links can and should be updated. | |
| npm run update-internal-links -- --dry-run --check --strict \ | |
| src/fixtures/fixtures/content \ | |
| --exclude src/fixtures/fixtures/content/get-started/foo/typo-autotitling.md \ | |
| --exclude src/fixtures/fixtures/content/get-started/foo/anchor-autotitling.md | |
| npm run update-internal-links -- --dry-run --check --strict \ | |
| src/fixtures/fixtures/data | |
| - name: Clone all translations | |
| if: ${{ matrix.name == 'languages' }} | |
| uses: ./.github/actions/clone-translations | |
| with: | |
| token: ${{ secrets.DOCS_BOT_PAT_READPUBLICKEY }} | |
| - name: Gather files changed | |
| if: ${{ matrix.name == 'content-linter' }} | |
| env: | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| PR: ${{ github.event.pull_request.number }} | |
| HEAD: ${{ github.event.pull_request.head.ref || github.event.merge_group.head_ref }} | |
| run: | | |
| # Find the file diff in the pull request or merge group | |
| # If its a pull request, use the faster call to the GitHub API | |
| # For push, workflow_dispatch, and merge_group, use git diff | |
| if [ -n "$PR" ] | |
| then | |
| echo __ running gh pr diff __ | |
| DIFF=`gh pr diff $PR --name-only` | |
| elif [ -n "$HEAD" ] | |
| then | |
| echo __ running git fetch main __ | |
| git fetch origin main --depth 1 | |
| echo __ running git diff __ | |
| DIFF=`git diff --name-only origin/main` | |
| else | |
| echo __ no head, empty diff __ | |
| DIFF='' | |
| fi | |
| # So we can inspect the output | |
| echo __ DIFF found __ | |
| echo $DIFF | |
| # So that becomes a string like `foo.js path/bar.md` | |
| # Must do this because the list of files can be HUGE. Especially | |
| # in a repo-sync when there are lots of translation files involved. | |
| echo __ format, write to get_diff_files.txt __ | |
| echo $DIFF | tr '\n' ' ' > get_diff_files.txt | |
| - uses: ./.github/actions/cache-nextjs | |
| - name: Run build script | |
| run: npm run build | |
| - uses: ./.github/actions/warmup-remotejson-cache | |
| # Only the 'routing' tests include end-to-end tests about | |
| # archived enterprise server URLs. | |
| if: ${{ matrix.name == 'redirects' }} | |
| - uses: ./.github/actions/precompute-pageinfo | |
| # Only the 'pageinfo' tests include end-to-end tests about this. | |
| if: ${{ matrix.name == 'pageinfo' }} | |
| env: | |
| ROOT: src/fixtures/fixtures | |
| - name: Index fixtures into the local Elasticsearch | |
| # For the sake of saving time, only run this step if the group | |
| # is one that will run tests against an Elasticsearch on localhost. | |
| if: ${{ matrix.name == 'search' || matrix.name == 'languages' }} | |
| run: npm run index-test-fixtures | |
| - name: Run tests | |
| env: | |
| DIFF_FILE: get_diff_files.txt | |
| CHANGELOG_CACHE_FILE_PATH: src/fixtures/fixtures/changelog-feed.json | |
| # By default, when `process.env.NODE_ENV === 'test'` it forces the | |
| # tests run only in English. The exception is the | |
| # `languages` suite which needs all languages to be set up. | |
| ENABLED_LANGUAGES: ${{ matrix.name == 'languages' && 'all' || '' }} | |
| ROOT: ${{ (matrix.name == 'fixtures' || matrix.name == 'pageinfo' || matrix.name == 'landings' ) && 'src/fixtures/fixtures' || '' }} | |
| TRANSLATIONS_FIXTURE_ROOT: ${{ (matrix.name == 'fixtures' || matrix.name == 'pageinfo') && 'src/fixtures/fixtures/translations' || '' }} | |
| run: npm test -- src/${{ matrix.name }}/tests/ |