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.

ℹ️ Examples workflows

➡️ Available options for this plugin

- uses: lowlighter/metrics@latest
  with:
    # ... other options
    plugin_pagespeed: yes
    plugin_pagespeed_token: ${{ secrets.PAGESPEED_TOKEN }} # Optional but recommended
    plugin_pagespeed_detailed: yes                         # Print detailed audit metrics
    plugin_pagespeed_screenshot: no                        # Display a screenshot of your website
    plugin_pagespeed_url: .user.website                    # Website to audit (defaults to your GitHub linked website)