Add Lighthouse-CI #5492 #5521
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| name: Google Lighthouse | ||
|
|
||
| on: | ||
|
There was a problem hiding this comment. I'm not sure this is correct, I believe the |
||
| issue_comment: | ||
| types: [edited] | ||
|
|
||
| jobs: | ||
| generate_lighthouse_audit: | ||
| timeout-minutes: 30 | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Add comment to PR | ||
| id: loading_comment_to_pr | ||
| uses: marocchino/sticky-pull-request-comment@v2 | ||
| with: | ||
| GITHUB_TOKEN: ${{ secrets.LIGHTHOUSE_APP_TOKEN }} | ||
|
There was a problem hiding this comment. This should not be set. By default it will use |
||
| number: ${{ github.event.issue.number }} | ||
| header: lighthouse | ||
| message: | | ||
| Running Lighthouse audit... | ||
| - name: Capture Vercel preview URL | ||
| id: vercel_preview_url | ||
| uses: aaimio/[email protected] | ||
| with: | ||
| GITHUB_TOKEN: ${{ secrets.LIGHTHOUSE_APP_TOKEN }} | ||
| - uses: actions/checkout@v3 | ||
| - name: Audit preview URL with Lighthouse | ||
| id: lighthouse_audit | ||
| uses: treosh/lighthouse-ci-action@v10 | ||
| with: | ||
| urls: | | ||
| ${{ steps.vercel_preview_url.outputs.vercel_preview_url }} | ||
| uploadArtifacts: true | ||
| temporaryPublicStorage: true | ||
| - name: Format lighthouse score | ||
| id: format_lighthouse_score | ||
| uses: actions/github-script@v3 | ||
| with: | ||
| github-token: ${{secrets.LIGHTHOUSE_APP_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 PR:`, | ||
| '| Category | Score |', | ||
| '| --- | --- |', | ||
| `| ${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); | ||
|
There was a problem hiding this comment. The indentation of this line is wrong. |
||
| - name: Add comment to PR | ||
| id: comment_to_pr | ||
| uses: marocchino/sticky-pull-request-comment@v1 | ||
| with: | ||
| GITHUB_TOKEN: ${{ secrets.LIGHTHOUSE_APP_TOKEN }} | ||
| number: ${{ github.event.issue.number }} | ||
| header: lighthouse | ||
| message: | | ||
| ${{ steps.format_lighthouse_score.outputs.comment }} | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| { | ||
| "ci": { | ||
| "collect": { | ||
| "startServerCommand": "npm run serve", | ||
| "startServerReadyPattern": "Server running at http://localhost:3000/", | ||
| "url": [ | ||
| "http://localhost:3000/en", | ||
ovflowd marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| "http://localhost:3000/en/about", | ||
| "http://localhost:3000/en/download", | ||
| "http://localhost:3000/en/docs", | ||
| "http://localhost:3000/en/get-involved", | ||
| "http://localhost:3000/en/blog" | ||
| ], | ||
| "numberOfRuns": 1, | ||
| "settings": { | ||
| "preset": "desktop" | ||
| } | ||
| }, | ||
| "upload": { | ||
| "target": "temporary-public-storage" | ||
ovflowd marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| }, | ||
| "assert": { | ||
| "preset": "lighthouse:recommended" | ||
| } | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We shouldn't create yet another GitHub Actions Workflow, this should be added on the
build-and-analysis.ymlWorkflow, as a separate job. It can just be called "lighthouse"Also, it'd be great to give a
name:field as "Google Lighthouse"`There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will move this to build and analysis.yml and also the name