E2E (Applitools) #23
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: E2E (Applitools) | |
| on: | |
| workflow_dispatch: | |
| # Because we want to limit Applitools usage, so we only want to start this | |
| # workflow on rare occasions/manually. | |
| inputs: | |
| parent_branch: | |
| required: true | |
| type: string | |
| default: master | |
| description: 'Parent branch to use for PRs' | |
| permissions: | |
| contents: read | |
| env: | |
| # on PRs from forks, this secret will always be empty, for security reasons | |
| USE_APPLI: ${{ secrets.APPLITOOLS_API_KEY && 'true' || '' }} | |
| jobs: | |
| e2e-applitools: | |
| runs-on: ubuntu-latest | |
| container: | |
| image: cypress/browsers:node-20.11.0-chrome-121.0.6167.85-1-ff-120.0-edge-121.0.2277.83-1 | |
| options: --user 1001 | |
| steps: | |
| - if: ${{ ! env.USE_APPLI }} | |
| name: Warn if not using Applitools | |
| run: | | |
| echo "::error,title=Not using Applitools::APPLITOOLS_API_KEY is empty, disabling Applitools for this run." | |
| - uses: actions/checkout@v4 | |
| - uses: pnpm/action-setup@v2 | |
| # uses version from "packageManager" field in package.json | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: '.node-version' | |
| - if: ${{ env.USE_APPLI }} | |
| name: Notify applitools of new batch | |
| # Copied from docs https://applitools.com/docs/topics/integrations/github-integration-ci-setup.html | |
| run: curl -L -d '' -X POST "$APPLITOOLS_SERVER_URL/api/externals/github/push?apiKey=$APPLITOOLS_API_KEY&CommitSha=$GITHUB_SHA&BranchName=${APPLITOOLS_BRANCH}$&ParentBranchName=$APPLITOOLS_PARENT_BRANCH" | |
| env: | |
| # e.g. mermaid-js/mermaid/my-branch | |
| APPLITOOLS_BRANCH: ${{ github.repository }}/${{ github.ref_name }} | |
| APPLITOOLS_PARENT_BRANCH: ${{ github.event.inputs.parent_branch }} | |
| APPLITOOLS_API_KEY: ${{ secrets.APPLITOOLS_API_KEY }} | |
| APPLITOOLS_SERVER_URL: 'https://eyesapi.applitools.com' | |
| - name: Cypress run | |
| uses: cypress-io/github-action@v4 | |
| id: cypress | |
| with: | |
| start: pnpm run dev | |
| wait-on: 'http://localhost:9000' | |
| env: | |
| # Mermaid applitools.config.js uses this to pick batch name. | |
| APPLI_BRANCH: ${{ github.ref_name }} | |
| APPLITOOLS_BATCH_ID: ${{ github.sha }} | |
| # e.g. mermaid-js/mermaid/my-branch | |
| APPLITOOLS_BRANCH: ${{ github.repository }}/${{ github.ref_name }} | |
| APPLITOOLS_PARENT_BRANCH: ${{ github.event.inputs.parent_branch }} | |
| APPLITOOLS_API_KEY: ${{ secrets.APPLITOOLS_API_KEY }} | |
| APPLITOOLS_SERVER_URL: 'https://eyesapi.applitools.com' |