update ReadMe & compono #164
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: Vercel Preview URL Lighthouse Audit | |
| on: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| generate_lighthouse_audit: | |
| timeout-minutes: 30 | |
| runs-on: ubuntu-latest | |
| steps: | |
| # wait arbitrary 120s for the build to finish, changes it if your builds are longer. Potential fix: https://github.com/marketplace/actions/await-for-vercel-deployment | |
| - run: sleep 120 | |
| - name: Capture Vercel preview URL | |
| id: vercel_preview_url | |
| uses: zentered/[email protected] | |
| env: | |
| VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }} | |
| with: | |
| # find project id here: https://vercel.com/studio-freight/satus/settings | |
| vercel_team_id: 'studio-freight' | |
| vercel_project_id: ${{ secrets.VERCEL_PROJECT_ID }} | |
| - uses: actions/[email protected] | |
| - name: Audit preview URL with Lighthouse | |
| id: lighthouse_audit | |
| uses: treosh/lighthouse-ci-action@v9 | |
| with: | |
| urls: | | |
| "https://${{ steps.vercel_preview_url.outputs.preview_url }}" | |
| uploadArtifacts: true | |
| temporaryPublicStorage: true | |
| - name: Format lighthouse score | |
| id: format_lighthouse_score | |
| uses: actions/github-script@v6 | |
| with: | |
| github-token: ${{secrets.GITHUB_TOKEN}} | |
| script: | | |
| const result = ${{ steps.lighthouse_audit.outputs.manifest }}[0].summary | |
| const links = ${{ steps.lighthouse_audit.outputs.links }} | |
| const formatResult = (res) => Math.round((res * 100)) | |
| Object.keys(result).forEach(key => result[key] = formatResult(result[key])) | |
| const score = res => res >= 90 ? '🟢' : res >= 50 ? '🟠' : '🔴' | |
| const comment = [ | |
| `⚡️ [Lighthouse report](${Object.values(links)[0]}) for the changes in this commit:`, | |
| '', | |
| `${score(result.performance)} Performance: ${result.performance}`, | |
| `${score(result.accessibility)} Accessibility: ${result.accessibility}`, | |
| `${score(result['best-practices'])} Best practices: ${result['best-practices']}`, | |
| `${score(result.seo)} SEO: ${result.seo}`, | |
| `${score(result.pwa)} PWA: ${result.pwa}`, | |
| ' ', | |
| `*Lighthouse ran on [${Object.keys(links)[0]}](${Object.keys(links)[0]})*` | |
| ].join('\n') | |
| core.setOutput("comment", comment); | |
| - name: Create commit comment | |
| uses: peter-evans/commit-comment@v2 | |
| with: | |
| body: | | |
| "${{ steps.format_lighthouse_score.outputs.comment }}" |