[Mobile App]: Improve Testing Documentation (currently Google Doc) #952
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 workflow's goal is forcing an update of the reference snapshots used | |
| # by Playwright tests. It runs whenever you post a new pull request comment | |
| # that strictly matches the "/update-functions-snapshots". | |
| # It works like this: | |
| # 1. Because of a GitHub Action limitation, this workflow is triggered on every | |
| # comment posted on an issue or pull request. We manually interrupt it unless | |
| # the comment content strictly matches "/update-functions-snapshots" and we're in a | |
| # pull request. | |
| # 2. Use the GitHub API to grab the information about the branch name and SHA of | |
| # the latest commit of the current pull request. | |
| # 3. Update the Playwright reference snapshots based on the UI of this branch. | |
| # 4. Commit the newly generated Playwright reference snapshots into this branch. | |
| name: Update Functions Snapshots | |
| on: | |
| # It looks like you can't target PRs-only comments: | |
| # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_comment-use-issue_comment | |
| # So we must run this workflow every time a new comment is added to issues | |
| # and pull requests | |
| issue_comment: | |
| types: [created] | |
| jobs: | |
| update_functions_snapshots: | |
| # Run this job only on comments of pull requests that strictly match | |
| # the "/update-functions-snapshots" string | |
| if: ${{ github.event.issue.pull_request && github.event.comment.body == '/update-functions-snapshots'}} | |
| timeout-minutes: 60 | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 # Load all commits | |
| token: ${{ secrets.WORKFLOW_TOKEN }} | |
| - name: Initialize repository | |
| uses: ./.github/workflows/actions/init | |
| with: | |
| installDependencies: "false" | |
| # Get the SHA and branch name of the comment's pull request | |
| # We must use the GitHub API to retrieve these information because they're | |
| # not accessible within workflows triggered by "issue_comment" | |
| - name: Get SHA & branch name | |
| id: get-branch-and-sha | |
| run: | | |
| sha_and_branch=$(\ | |
| curl \ | |
| -H 'authorization: Bearer ${{ secrets.GITHUB_TOKEN }}' \ | |
| https://api.github.com/repos/${{ github.repository }}/pulls/${{ github.event.issue.number }} \ | |
| | jq -r '.head.sha," ",.head.ref'); | |
| echo "::set-output name=sha::$(echo $sha_and_branch | cut -d " " -f 1)"; | |
| echo "::set-output name=branch::$(echo $sha_and_branch | cut -d " " -f 2)" | |
| # Checkout the comment's branch | |
| - name: Fetch branch | |
| run: git fetch | |
| - name: Checkout branch | |
| run: git checkout ${{ steps.get-branch-and-sha.outputs.branch }} | |
| - name: Install Dependencies | |
| run: npm ci | |
| - name: Run e2e tests | |
| run: npm run functions:test:playwright:update | |
| - name: Commit changes | |
| uses: stefanzweifel/git-auto-commit-action@v4 | |
| with: | |
| commit_message: "[CI] Update Functions Snapshots" |