Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Make Lighthouse CI run on local build #9447

Merged
merged 10 commits into from
Oct 25, 2023
Merged

chore: Make Lighthouse CI run on local build #9447

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
51655ca
Make Lighthouse CI run on local build
slorber Oct 25, 2023
5d44680
temp switch to pull_request workflow
slorber Oct 25, 2023
2f487f0
revert
slorber Oct 25, 2023
94a7eab
test
slorber Oct 25, 2023
ad1b259
test
slorber Oct 25, 2023
6881148
test
slorber Oct 25, 2023
636dc4c
fix CI error
slorber Oct 25, 2023
5dde19b
fix CI error
slorber Oct 25, 2023
d32981b
Add 5 lighthouse runs
slorber Oct 25, 2023
d7ee83f
cleanup
slorber Oct 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 18 additions & 14 deletions .github/workflows/lighthouse-report.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,29 +22,33 @@ jobs:
steps:
- name: Checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
- name: Wait for the Netlify Preview
uses: jakepartusch/wait-for-netlify-action@f1e137043864b9ab9034ae3a5adc1c108e3f1a48 # v1
id: netlify

- name: Use Node.js
uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0
with:
site_name: docusaurus-2
max_timeout: 600
node-version: 18

- name: Install dependencies
run: yarn install --frozen-lockfile

- name: Build website fast
run: yarn build:website:fast

- name: Audit URLs using Lighthouse
id: lighthouse_audit
uses: treosh/lighthouse-ci-action@03becbfc543944dd6e7534f7ff768abb8a296826 # 10.1.0
with:
urls: |
https://deploy-preview-$PR_NUMBER--docusaurus-2.netlify.app/
https://deploy-preview-$PR_NUMBER--docusaurus-2.netlify.app/docs/installation/
https://deploy-preview-$PR_NUMBER--docusaurus-2.netlify.app/docs/category/getting-started/
https://deploy-preview-$PR_NUMBER--docusaurus-2.netlify.app/blog/
https://deploy-preview-$PR_NUMBER--docusaurus-2.netlify.app/blog/preparing-your-site-for-docusaurus-v3/
https://deploy-preview-$PR_NUMBER--docusaurus-2.netlify.app/blog/tags/release/
https://deploy-preview-$PR_NUMBER--docusaurus-2.netlify.app/blog/tags/
http://localhost:3000
http://localhost:3000/docs/installation
http://localhost:3000/docs/category/getting-started
http://localhost:3000/blog
http://localhost:3000/blog/preparing-your-site-for-docusaurus-v3
http://localhost:3000/blog/tags/release
http://localhost:3000/blog/tags
configPath: ./.github/workflows/lighthouserc.json
uploadArtifacts: true
temporaryPublicStorage: true
env:
PR_NUMBER: ${{ github.event.pull_request.number}}

- name: Format lighthouse score
id: format_lighthouse_score
Expand Down
6 changes: 6 additions & 0 deletions .github/workflows/lighthouserc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
{
"ci": {
"collect": {
"startServerCommand": "yarn serve:website",
"startServerReadyPattern": "Serving",
"startServerReadyTimeout": 10000,

"numberOfRuns": 5,

"settings": {
"skipAudits": [
"robots-txt",
Expand Down
14 changes: 13 additions & 1 deletion admin/scripts/formatLighthouseReport.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,18 @@ const scoreEntry = (rawScore) => {
return `${scoreIcon} ${score}`;
};

/**
* @param {string} url
* @returns {module:url.URL}
*/
function createURL(url) {
try {
return new URL(url);
} catch (e) {
throw new Error(`Can't create URL for string=${url}`, {cause: e});
}
}

/**
* @param {Object} param0
* @param {string} param0.url
Expand All @@ -34,7 +46,7 @@ const scoreEntry = (rawScore) => {
*/
const createMarkdownTableRow = ({url, summary, reportUrl}) =>
[
`| [${new URL(url).pathname}](${url})`,
`| [${createURL(url).pathname}](${url})`,
.../** @type {(keyof LighthouseSummary)[]} */ (
Object.keys(summaryKeys)
).map((k) => scoreEntry(summary[k])),
Expand Down