ggardin / psi-action

A GitHub action that utilizes Google's Page Speed Insights to generate a performance report

Page Speed Insights — A GitHub Action 🏎

This action utilizes Google's Page Speed Insights to generate a report on your website's performance

Inputs

url

Required The name of the site to reach https://google.com

key

Optional - API key (recommended for production) to use when consuming the Page Speed Insights API. This should be stored as a Github Secret. You can request a key here

strategy

Optional — Strategy to use when analyzing the page (mobile/desktop).

threshold

Optional — Score to pass the PageSpeed test. Useful for setting a performance budget (default 70).

Example usage

Basic Usage

steps:
  - name: Running Page Speed Insights
    uses: jakepartusch/[email protected]
    id: psi
    with:
      url: "https://jake.partus.ch"
      threshold: 70
      strategy: mobile
      key: ${{ secrets.APIKEY }}