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

Type	Description
plugin_pagespeed	Display a website Google PageSpeed metrics
type: boolean default: no
plugin_pagespeed_url	Audited website
type: string default: → User attached website
plugin_pagespeed_detailed	Detailed audit result
type: boolean default: no
plugin_pagespeed_screenshot	Display a screenshot of your website
type: boolean default: no
plugin_pagespeed_token	PageSpeed token
🔐 Token type: token

→ Full specification

ℹ️ Examples workflows

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

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

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