chore: doc update #35
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
| # https://help.github.com/en/categories/automating-your-workflow-with-github-actions | |
| name: "Tests" | |
| on: # yamllint disable-line rule:truthy | |
| push: | |
| branches: | |
| - "main" | |
| pull_request: # yamllint disable-line rule:empty-values | |
| concurrency: | |
| group: "ci-tests-${{ github.ref }}-1" | |
| cancel-in-progress: true | |
| permissions: | |
| contents: "read" # to fetch code (actions/checkout) | |
| jobs: | |
| files-changed: | |
| name: "Detect what files changed" | |
| runs-on: "ubuntu-22.04" | |
| timeout-minutes: 3 | |
| # Map a step output to a job output | |
| outputs: | |
| packages: "${{ steps.changes.outputs.packages }}" | |
| steps: | |
| - name: "Harden Runner" | |
| uses: "step-security/harden-runner@8ca2b8b2ece13480cda6dacd3511b49857a23c09" # v2.5.1 | |
| with: | |
| egress-policy: "audit" | |
| - name: "Git checkout" | |
| uses: "actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744" # v3.6.0 | |
| env: | |
| GIT_COMMITTER_NAME: "GitHub Actions Shell" | |
| GIT_AUTHOR_NAME: "GitHub Actions Shell" | |
| EMAIL: "github-actions[bot]@users.noreply.github.com" | |
| - name: "Check for file changes" | |
| uses: "dorny/paths-filter@4512585405083f25c027a35db413c2b3b9006d50" # v2.11.1 | |
| id: "changes" | |
| with: | |
| token: "${{ github.token }}" | |
| filters: ".github/file-filters.yml" | |
| test: | |
| if: "needs.files-changed.outputs.packages == 'true'" | |
| needs: "files-changed" | |
| strategy: | |
| matrix: | |
| os: ["ubuntu-latest"] | |
| node_version: ["18"] | |
| fail-fast: false | |
| name: "Test (node-${{ matrix.node_version }}, ${{ matrix.os }})" | |
| runs-on: "${{ matrix.os }}" | |
| steps: | |
| - name: "Harden Runner" | |
| uses: "step-security/harden-runner@8ca2b8b2ece13480cda6dacd3511b49857a23c09" # v2.5.1 | |
| with: | |
| egress-policy: "audit" | |
| - name: "Git checkout" | |
| uses: "actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744" # v3.6.0 | |
| env: | |
| GIT_COMMITTER_NAME: "GitHub Actions Shell" | |
| GIT_AUTHOR_NAME: "GitHub Actions Shell" | |
| EMAIL: "github-actions[bot]@users.noreply.github.com" | |
| - uses: "pnpm/action-setup@d882d12c64e032187b2edb46d3a0d003b7a43598" # v2.4.0 | |
| with: | |
| run_install: false | |
| - name: "Set node version to ${{ matrix.node_version }}" | |
| uses: "actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d" # v3.8.1 | |
| with: | |
| node-version: "${{ matrix.node_version }}" | |
| cache: "pnpm" | |
| - name: "Check npm version" | |
| run: "npm -v" | |
| env: | |
| SKIP_CHECK: "true" | |
| - name: "Install packages" | |
| run: "pnpm install --frozen-lockfile" | |
| env: | |
| SKIP_CHECK: "true" | |
| - name: "Verify the integrity of provenance attestations and registry signatures for installed dependencies" | |
| run: "pnpm audit signatures" | |
| - name: "test and coverage" | |
| run: "pnpm run test:coverage" | |
| # This check runs once all dependant jobs have passed | |
| # It symbolizes that all required Frontend checks have succesfully passed (Or skipped) | |
| # This check is the only required Github check | |
| test-required-check: | |
| needs: ["files-changed", "test"] | |
| name: "Check Test Run" | |
| # This is necessary since a failed/skipped dependent job would cause this job to be skipped | |
| if: "always()" | |
| runs-on: "ubuntu-22.04" | |
| steps: | |
| # If any jobs we depend on fail, we will fail since this is a required check | |
| # NOTE: A timeout is considered a failure | |
| - name: "Harden Runner" | |
| uses: "step-security/harden-runner@8ca2b8b2ece13480cda6dacd3511b49857a23c09" # v2.5.1 | |
| with: | |
| egress-policy: "audit" | |
| - name: "Check for failures" | |
| if: "contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled')" | |
| run: | | |
| echo "One of the dependent jobs have failed. You may need to re-run it." && exit 1 |