Add Lighthouse comments only on PRs #242
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: CI | |
| on: | |
| # Can run on command | |
| workflow_dispatch: | |
| # Can be run by other actions | |
| workflow_call: | |
| # Runs on pull requests | |
| pull_request: | |
| branches: [master] | |
| jobs: | |
| build: | |
| name: build-and-test | |
| # Running on ubuntu-latest, nothing special | |
| runs-on: ubuntu-latest | |
| steps: | |
| # As usual, we simply checkout the project | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| # Setup the latest version of Bun | |
| - uses: oven-sh/setup-bun@v1 | |
| with: | |
| bun-version: latest | |
| # Install project dependencies | |
| - name: Install dependencies | |
| run: bun install --frozen-lockfile | |
| # Make sure the application can build | |
| - name: Build application | |
| run: bun run build | |
| # Now we run our tests | |
| - name: Run tests | |
| run: bun run test | |
| # Now we run our lints | |
| - name: Run lints | |
| run: bun run lint | |
| # Now we run our pretty checks for code formatting | |
| - name: Run pretty checks | |
| run: bun run pretty-check | |
| # Finally we run svelte-check for some last minute svelte sanity | |
| - name: Run svelte-check | |
| run: bun run svelte-check | |
| - name: Jest Coverage Comment | |
| # This comments the current Jest Coverage Report containing JUnit XML reports | |
| # and a Code Coverage Summary | |
| uses: MishaKav/jest-coverage-comment@434e6d2d37116d23d812809b61d499639842fa3b # v1.0.26 | |
| with: | |
| title: "Unit Test Coverage Report" | |
| junitxml-path: ./test-results.xml | |
| junitxml-title: Unit Test Report | |
| test: | |
| # Runs on execution of build | |
| needs: build | |
| name: playwright-test | |
| # Running on ubuntu-latest, nothing special | |
| runs-on: ubuntu-latest | |
| steps: | |
| # As usual, we simply checkout the project | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| # Setup the latest version of Bun | |
| - uses: oven-sh/setup-bun@v1 | |
| with: | |
| bun-version: latest | |
| # Install project dependencies | |
| - name: Install dependencies | |
| run: bun install --frozen-lockfile | |
| # Install Playwright browsers | |
| - name: Install Playwright Browsers | |
| run: bunx playwright install --with-deps | |
| # Run Playwright tests | |
| - name: Run tests | |
| run: bun run test:playwright | |
| analyze: | |
| # Runs on successful playwright | |
| needs: [build, test] | |
| name: lighthouse-test | |
| # Running on ubuntu-latest, nothing special | |
| runs-on: ubuntu-latest | |
| steps: | |
| # As usual, we simply checkout the project | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| # Setup the latest version of Bun | |
| - uses: oven-sh/setup-bun@v1 | |
| with: | |
| bun-version: latest | |
| # Install project dependencies | |
| - name: Install dependencies | |
| run: bun install --frozen-lockfile | |
| # Install Playwright browsers | |
| - name: Install Playwright Browsers | |
| run: bunx playwright install --with-deps | |
| # Run Lighthouse Playwright tests | |
| - name: Run Playwright tests | |
| run: bun run test:lighthouse | |
| - name: Read JSON and set output | |
| id: json-reader | |
| run: | | |
| categories=$(jq -c '.categories' ./lighthouse-reports/lighthouse.json) | |
| echo "::set-output name=json::$categories" | |
| - name: Format Lighthouse Score | |
| # Transform the audit results into a single, friendlier output | |
| id: format-lighthouse-score | |
| uses: actions/github-script@d7906e4ad0b1822421a7e6a35d5ca353c962f410 # v6.4.1 | |
| env: | |
| # using env as input to our script | |
| # see https://github.com/actions/github-script#use-env-as-input | |
| LIGHTHOUSE_RESULT: ${{ steps.json-reader.outputs.json }} | |
| with: | |
| # Run as a separate file so we do not have to inline all of our formatting logic. | |
| # See https://github.com/actions/github-script#run-a-separate-file for more info. | |
| script: | | |
| const { formatLighthouseResults } = await import('${{github.workspace}}/scripts/lighthouse/index.js') | |
| await formatLighthouseResults({core}) | |
| - name: Add Comment to PR | |
| if: ${{ github.event_name == 'pull_request' && github.base_ref != 'master' }} | |
| # Replace the previous message with our formatted lighthouse results | |
| uses: thollander/actions-comment-pull-request@d61db783da9abefc3437960d0cce08552c7c004f # v2.4.2 | |
| with: | |
| # Reference the previously created comment | |
| comment_tag: "lighthouse-audit" | |
| message: | | |
| ${{ steps.format-lighthouse-score.outputs.comment }} |