metrics/source/plugins/pagespeed/README.md

⏱️ Website performances

The pagespeed plugin adds the performance statistics of the website attached on your account:

PageSpeed scores PageSpeed scores with detailed report PageSpeed scores with a website screenshot

These metrics are computed through Google's PageSpeed API, which yields the same results as web.dev.

See performance scoring and score calculator for more informations about how PageSpeed compute these statistics.

Although not mandatory, you can generate an API key for PageSpeed API here to avoid hitting rate limiter.

Expect 10 to 30 seconds to generate the results.

➡️ Available options

Option	Type (format) [default] {allowed values}	Description
plugin_pagespeed	boolean [no]	Display a website Google PageSpeed metrics
plugin_pagespeed_url	string [.user.website]	Audited website
plugin_pagespeed_detailed	boolean [no]	Detailed audit result
plugin_pagespeed_screenshot	boolean [no]	Display a screenshot of your website
plugin_pagespeed_token 🔐	token []	PageSpeed token

Legend for option icons:

• 🔐 Value should be stored in repository secrets
• ✨ New feature currently in testing on master/main

→ Full specification

ℹ️ Examples workflows

name: Succint report
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.pagespeed.svg
  token: NOT_NEEDED
  plugin_pagespeed: 'yes'
  plugin_pagespeed_token: ${{ secrets.PAGESPEED_TOKEN }}

name: Detailed report
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.pagespeed.detailed.svg
  token: NOT_NEEDED
  plugin_pagespeed: 'yes'
  plugin_pagespeed_detailed: 'yes'
  plugin_pagespeed_token: ${{ secrets.PAGESPEED_TOKEN }}

name: Screenshot
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.pagespeed.screenshot.svg
  token: NOT_NEEDED
  plugin_pagespeed: 'yes'
  plugin_pagespeed_screenshot: 'yes'
  plugin_pagespeed_token: ${{ secrets.PAGESPEED_TOKEN }}