Auto-update snapshot tests if changing strings #24
Workflow file for this run
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: Build Client | |
| on: | |
| push: | |
| branches: [main] | |
| paths: | |
| - ".github/workflows/build-client.yml" | |
| - "client/**/*" | |
| pull_request: | |
| paths: | |
| - ".github/workflows/build-client.yml" | |
| - "client/**/*" | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| env: | |
| node-version: 18 | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| defaults: | |
| run: | |
| working-directory: client | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Use Node.js ${{ env.node-version }} | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ env.node-version }} | |
| cache: npm | |
| cache-dependency-path: client/package-lock.json | |
| - name: Install | |
| run: npm ci | |
| - name: Build | |
| run: npm run build | |
| env: | |
| # See the client readme for more info on environment variables: | |
| # https://github.com/usds/justice40-tool/blob/main/client/README.md | |
| DATA_SOURCE: cdn | |
| SITE_URL: "${{ vars.SITE_URL }}" | |
| PATH_PREFIX: "${{ vars.PATH_PREFIX }}" | |
| - name: Get directory contents | |
| run: ls -la public | |
| - name: Upload static files as artifact | |
| id: deployment | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: ./client/public | |
| test: | |
| runs-on: ubuntu-latest | |
| needs: | |
| - translations | |
| defaults: | |
| run: | |
| working-directory: client | |
| permissions: | |
| contents: write # For commiting changes back to the current PR. | |
| pull-requests: write # For commenting on the PR. | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ needs.translations.outputs.commit_hash }} | |
| - name: Use Node.js ${{ env.node-version }} | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ env.node-version }} | |
| cache: npm | |
| cache-dependency-path: client/package-lock.json | |
| - name: Install | |
| run: npm ci | |
| # We want to know if this branch has changed the english strings, not | |
| # just if the `translations` job had to update it, so we need this check. | |
| - uses: dorny/paths-filter@v3 | |
| id: changes | |
| with: | |
| filters: | | |
| english: | |
| - client/src/intl/en.json | |
| - name: Unit tests | |
| env: | |
| update_snapshots: ${{ github.event_name == 'pull_request' && steps.changes.outputs.english == 'true' }} | |
| run: | | |
| echo "HEAD: '$(git rev-parse HEAD)'" | |
| echo 'CHECKOUT_REF: "${{ needs.translations.outputs.commit_hash }}"' | |
| echo "UPDATE_SNAPSHOTS: '${update_snapshots}'" | |
| echo '-------------------------------' | |
| if [ "${update_snapshots}" == 'true' ]; then | |
| echo 'UPDATING SNAPSHOTS' | |
| npm run test:update | |
| else | |
| echo 'NOT UPDATING SNAPSHOTS' | |
| npm test | |
| fi | |
| - name: Commit changes to Snapshots | |
| uses: stefanzweifel/git-auto-commit-action@v5 | |
| id: commit | |
| if: github.event_name == 'pull_request' | |
| with: | |
| commit_message: 'Auto-update snapshot tests' | |
| file_pattern: '*.snap' | |
| - name: Comment on the PR about changes | |
| uses: thollander/actions-comment-pull-request@v3 | |
| if: steps.commit.outputs.changes_detected == 'true' | |
| env: | |
| commit_url: 'https://github.com/${{ github.repository }}/commit/${{ steps.commit.outputs.commit_hash }}' | |
| with: | |
| message: > | |
| 🚨 The "snapshot" tests in your PR have been automatically updated | |
| because you changed some text in the app! **Make sure [the changes | |
| to `.snap` files](${{ env.commit_url }}) are correct** and don’t | |
| include other things that should *not* have changed. | |
| lint: | |
| runs-on: ubuntu-latest | |
| defaults: | |
| run: | |
| working-directory: client | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Use Node.js ${{ env.node-version }} | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ env.node-version }} | |
| cache: npm | |
| cache-dependency-path: client/package-lock.json | |
| - name: Install | |
| run: npm ci | |
| - name: Lint | |
| run: npm run lint | |
| - name: License Check | |
| run: npm run licenses | |
| # TODO: This was disabled in the original DOI repo. Much of the code here | |
| # is pretty out of date, so it is nowhere near passing a security audit, | |
| # but it would be good to fix that and re-enable this. | |
| # | |
| # - name: Check for security vulnerabilities | |
| # run: npm audit --production | |
| translations: | |
| runs-on: ubuntu-latest | |
| defaults: | |
| run: | |
| working-directory: client | |
| permissions: | |
| contents: write # For commiting changes back to the current PR. | |
| pull-requests: write # For commenting on the PR. | |
| outputs: | |
| changed: ${{ steps.commit-strings.outputs.changes_detected == 'true' }} | |
| commit_hash: ${{ steps.commit-strings.outputs.commit_hash }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Use Node.js ${{ env.node-version }} | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ env.node-version }} | |
| cache: npm | |
| cache-dependency-path: client/package-lock.json | |
| - name: Install | |
| run: npm ci | |
| - name: Extract English from source code | |
| if: github.event_name == 'pull_request' | |
| run: npm run intl:extract | |
| - name: Commit changes to English strings | |
| uses: stefanzweifel/git-auto-commit-action@v5 | |
| id: commit-strings | |
| if: github.event_name == 'pull_request' | |
| with: | |
| commit_message: 'Auto-update en.json from component source code' | |
| file_pattern: 'client/src/intl/en.json' | |
| - name: Comment on the PR about changes | |
| uses: thollander/actions-comment-pull-request@v3 | |
| if: steps.commit-strings.outputs.changes_detected == 'true' | |
| with: | |
| message: > | |
| :wave: FYI, your PR has been automatically updated with changes to | |
| `client/src/intl/en.json`, which contains all the translatable text | |
| from the application (probably because you made changes to | |
| the text of a component without updating this file). | |
| - name: Check Spanish translations | |
| # TODO: Make this error fatal when we have a strategy for translations! | |
| # | |
| # Right now, we are trying to quickly iterate on this community | |
| # deployment of CEJST and don't have a clear process or strategy around | |
| # how to handle translations. We're keeping this check in so we have an | |
| # eye on what is or isn't translated, but missing or deprecated | |
| # non-English strings should not stop the build and prevent us from | |
| # merging or deploying changes. | |
| continue-on-error: true | |
| run: | | |
| npm run test:intl-translations > output.txt \ | |
| || echo "Error: ${?}" > ./failed | |
| # Make sure you can see the output in the log! | |
| cat output.txt | |
| if [ -f ./failed ]; then | |
| { | |
| echo '⚠️ English and Spanish translations are mismatched.' | |
| echo '<details><summary>Details:</summary>' | |
| echo '' | |
| echo '```' | |
| cat output.txt | |
| echo '```' | |
| echo '' | |
| echo '</details>' | |
| } >> "${GITHUB_STEP_SUMMARY}" | |
| exit 1 | |
| else | |
| echo '✅ Translations in good shape.' >> "${GITHUB_STEP_SUMMARY}" | |
| fi | |
| deploy: | |
| if: github.ref == 'refs/heads/main' | |
| runs-on: ubuntu-latest | |
| needs: | |
| - build | |
| - test | |
| - lint | |
| - translations | |
| permissions: | |
| pages: write | |
| id-token: write | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |