← Back to plugins index

âąī¸ Website performances

This plugin adds 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.

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
OptionDescription

plugin_pagespeed

Enable pagespeed plugin

type: boolean
default: no

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

Display a website screenshot

Significantly increase filesize

type: boolean
default: no

plugin_pagespeed_token

PageSpeed token

Although not mandatory, it strongly advised to create one to avoid triggering the rate limiter. See PageSpeed documentation for more informations.

🔐 Token
type: token
## â„šī¸ Examples workflows ```yaml 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 ``` ```yaml 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 ``` ```yaml 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 ```