README.md

← Back to plugins index
⏱️ Google PageSpeed
This plugin displays performance statistics of a website. It uses Google's PageSpeed API (same as web.dev), see performance scoring and score calculator for more informations about results.
⚠️ Disclaimer	This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Google PageSpeed. All product and company names are trademarks™ or registered® trademarks of their respective holders.
Supported features → Full specification	📗 Classic template 📘 Repository template 📙 Terminal template
	👤 Users 👥 Organizations 📓 Repositories
	🗝️ plugin_pagespeed_token
PageSpeed scores PageSpeed scores with detailed report PageSpeed scores with a website screenshot

➡️ Available options

Option	Description
plugin_pagespeed	Enable pagespeed plugin
type: boolean default: no
plugin_pagespeed_token	PageSpeed token ⚠️ While not mandatory, it is strongly advised pass a token to avoid triggering the rate limiter. See PageSpeed documentation for more informations.
🔐 Token 🌐 Web instances must configure settings.json: metrics.api.google.pagespeed type: token
plugin_pagespeed_url	Audited website
⏯️ Cannot be preset type: string default: → User attached website
plugin_pagespeed_detailed	Detailed results The following additional stats will be displayed: First Contentful Paint Speed Index Largest Contentful Paint Time to Interactive Total Blocking Time Cumulative Layout Shift
type: boolean default: no
plugin_pagespeed_screenshot	Website screenshot Significantly increase filesize
type: boolean default: no
plugin_pagespeed_pwa	PWA Status
type: boolean default: no

ℹ️ Examples workflows

name: Succinct 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

name: Succinct report with PWA
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
  plugin_pagespeed_pwa: yes