ci: Fix workflow to update screenshots #4993
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,52 +12,131 @@ on: | |
| required: true | ||
|
|
||
| jobs: | ||
| set-pending-status: | ||
| name: Set Pending Status | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| 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@v3 | ||
| with: | ||
| ref: refs/pull/${{ inputs.pr }}/head | ||
|
|
||
| - name: Set commit status to pending | ||
|
There was a problem hiding this comment. Say, the first two steps of this workflow are the exact same as the steps of There was a problem hiding this comment. No, those are separate jobs. Each job runs with a clean slate. You're thinking of "steps" within jobs. Calling another workflow (run-lab-tests) requires its own job. So the jobs are: 1. Set pending status, 2. run test workflow, 3. update PR, 4. set final status |
||
| uses: ./.github/workflows/custom-actions/set-commit-status | ||
| with: | ||
| context: Update All Screenshots | ||
| state: pending | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| - name: Get artifacts | ||
| uses: actions/download-artifact@v3 | ||
| with: | ||
| path: new-screenshots | ||
|
|
||
| - name: Move screenshots | ||
| run: | | ||
| # The download-artifact action puts zip file contents into folders by | ||
| # the name of the artifact, so we can't have them downloaded directly | ||
| # to the screenshots folder. Here we move them into the correct | ||
| # locations. | ||
| cd new-screenshots | ||
|
|
||
| # "$i" is a folder for an artifact (eg "screenshots-ChromeAndroid"), | ||
| # and it contains a single folder with the name we use in our | ||
| # screenshots (eg "chrome-Android"). We want the contents of that | ||
| # inner folder to be copied to test/test/assets/screenshots/, where a | ||
| # folder with the same name (eg "chrome-Android") already exists. | ||
| for i in screenshots*; do | ||
| cp -a $i/* ../test/test/assets/screenshots/ | ||
| done | ||
|
|
||
| - 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@v3 | ||
| 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 run-lab-tests succeeded, use the status of update-pr, otherwise | ||
| # use run-lab-tests (which is "failed" or "error"). | ||
| if [ "$LAB_TEST_STATUS" == "success" ]; then | ||
| echo "status=$UPDATE_PR_STATUS" >> $GITHUB_OUTPUT | ||
| else | ||
| echo "status=$LAST_TEST_STATUS" >> $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 }} | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"in tact" -> "intact"
Unless you're saying that using an array makes the elements remain tactful and sensitive.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done