Update All Screenshots #11
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: Update All Screenshots | |
| # Updates all screenshots on an existing PR, assuming permission has been given | |
| # to maintainers to make edits. | |
| on: | |
| workflow_dispatch: | |
| # Allows for manual triggering on PRs. They should be reviewed first, to | |
| # avoid malicious code executing in the lab. | |
| inputs: | |
| pr: | |
| description: "A PR number to build and test in the lab, then update all the screenshots." | |
| required: true | |
| jobs: | |
| set-pending-status: | |
| name: Set Pending Status | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| ref: refs/pull/${{ inputs.pr }}/head | |
| - name: Set commit status to pending | |
| uses: ./.github/workflows/custom-actions/set-commit-status | |
| with: | |
| context: Update All Screenshots | |
| state: pending | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| run-lab-tests: | |
| name: Get Selenium Lab Screenshots | |
| needs: [set-pending-status] | |
| uses: ./.github/workflows/selenium-lab-tests.yaml | |
| with: | |
| pr: ${{ inputs.pr }} | |
| test_filter: layout | |
| ignore_test_status: true | |
| update-pr: | |
| name: Update PR | |
| runs-on: ubuntu-latest | |
| needs: [run-lab-tests] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| ref: refs/pull/${{ inputs.pr }}/head | |
| - name: Get artifacts | |
| uses: actions/download-artifact@v4 | |
| with: | |
| path: test/test/assets/screenshots/ | |
| pattern: screenshots-* | |
| merge-multiple: true | |
| - name: Update screenshots | |
| run: | | |
| # Install prerequisites. | |
| npm ci | |
| # Update the official screenshots for any that have visibly changed. | |
| # This is not a byte-for-byte comparison, but based on pixel diffs. | |
| ./build/updateScreenshots.py | |
| # Emulate the actions bot. | |
| git config user.name "github-actions[bot]" | |
| git config user.email "41898282+github-actions[bot]@users.noreply.github.com" | |
| # Commit the changes. Ignore failure, in case there are no changes. | |
| git add test/test/assets/screenshots/*/*.png || true | |
| git commit -m ':robot: Update all screenshots' || true | |
| - name: Update PR | |
| env: | |
| GH_TOKEN: ${{ github.token }} | |
| run: | | |
| # Update the PR. | |
| PR_API_URL="/repos/${{ github.repository }}/pulls/${{ inputs.pr }}" | |
| REMOTE=$(gh api $PR_API_URL | jq -r .head.repo.html_url) | |
| BRANCH=$(gh api $PR_API_URL | jq -r .head.ref) | |
| # If there were no changes, this will do nothing, but succeed. | |
| git push "$REMOTE" HEAD:"$BRANCH" | |
| - name: Debug | |
| uses: mxschmitt/[email protected] | |
| with: | |
| limit-access-to-actor: true | |
| if: failure() | |
| set-final-status: | |
| name: Set Final Status | |
| runs-on: ubuntu-latest | |
| needs: [run-lab-tests, update-pr] | |
| # Will run on success or failure, but not if the workflow is cancelled. | |
| if: ${{ success() || failure() }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| ref: refs/pull/${{ inputs.pr }}/head | |
| - name: Compute final status | |
| id: compute | |
| run: | | |
| LAB_TEST_STATUS="${{ needs.run-lab-tests.status }}" | |
| UPDATE_PR_STATUS="${{ needs.update-pr.status }}" | |
| if [[ "$LAB_TEST_STATUS" == "success" ]]; then | |
| # If run-lab-tests succeeded, use the status of update-pr. | |
| # If that is blank, default to "error". | |
| echo "status=${UPDATE_PR_STATUS:-error}" >> $GITHUB_OUTPUT | |
| else | |
| # If lab status is not success, use that status. | |
| # If that is blank, default to "error". | |
| echo "status=${LAB_TEST_STATUS:-error}" >> $GITHUB_OUTPUT | |
| fi | |
| - name: Report final status | |
| uses: ./.github/workflows/custom-actions/set-commit-status | |
| with: | |
| context: Update All Screenshots | |
| state: ${{ steps.compute.outputs.status }} | |
| token: ${{ secrets.GITHUB_TOKEN }} |