diff --git a/pages.yml b/pages.yml new file mode 100644 index 00000000..e978d8a4 --- /dev/null +++ b/pages.yml @@ -0,0 +1,85 @@ +[![Browser Tests](https://github.com/behnamkhanioffical/Central-Index/actions/workflows/browser-test.yml/badge.svg)](https://github.com/behnamkhanioffical/Central-Index/actions/workflows/browser-test.yml) +name: Browser Tests + +# **What it does**: This runs our browser tests on pull requests. +# **Why we have it**: This is the only way we currently test our browser JavaScript. +# **Who does it impact**: Docs engineering, open-source engineering contributors. + +on: + workflow_dispatch: + pull_request: + paths: + - '**.js' + - '**.mjs' + - '**.ts' + - '**.tsx' + - jest.config.js + - package.json + # In case something like eslint or tsc or prettier upgrades + - package-lock.json + # Ultimately, for debugging this workflow itself + - .github/workflows/browser-test.yml + +permissions: + contents: 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: + ELASTICSEARCH_URL: http://localhost:9200/ + +jobs: + build: + if: github.repository == 'github/docs-internal' || github.repository == 'github/docs' + runs-on: ${{ fromJSON('["ubuntu-latest", "ubuntu-20.04-xl"]')[github.repository == 'github/docs-internal'] }} + steps: + - name: Install a local Elasticsearch for testing + # For the sake of saving time, only run this step if the test-group + # is one that will run tests against an Elasticsearch on localhost. + uses: getong/elasticsearch-action@95b501ab0c83dee0aac7c39b7cea3723bef14954 + with: + # Make sure this matches production and `sync-search-pr.yml` + elasticsearch version: '7.11.1' + host port: 9200 + container port: 9200 + host node port: 9300 + node port: 9300 + discovery type: 'single-node' + + - name: Checkout + uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 + + - name: Setup Node.js + uses: actions/setup-node@8c91899e586c5b171469028077307d293428b516 + with: + node-version-file: '.node-version' + cache: npm + + - name: Install dependencies + env: + # This makes it so the puppeteer npm package doesn't bother + # to download a copy of chromium because it can use + # `$PUPPETEER_EXECUTABLE_PATH` from the ubuntu Action container. + PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: true + run: npm ci --include=optional + + - name: Cache nextjs build + uses: actions/cache@9b0c1fce7a93df8e3bb8926b0d6e9d89e92f20a7 + with: + path: .next/cache + key: ${{ runner.os }}-nextjs-${{ hashFiles('package*.json') }} + + - name: Run build script + run: npm run build + + - name: Index fixtures into the local Elasticsearch + run: npm run index-test-fixtures + + - name: Check that Elasticsearch is accessible + run: | + curl --fail --retry-connrefused --retry 5 -I ${{ env.ELASTICSEARCH_URL }} + - name: Run browser-test + run: npm run browser-test