https://github.com/adobe-rnd/helix-psi-github-action

The Helix PSI GitHub Action audits a PR against the Page Speed Insights API
https://github.com/adobe-rnd/helix-psi-github-action

Last synced: 11 days ago
JSON representation

The Helix PSI GitHub Action audits a PR against the Page Speed Insights API

• Host: GitHub
• URL: https://github.com/adobe-rnd/helix-psi-github-action
• Owner: adobe-rnd
• License: apache-2.0
• Created: 2021-08-24T17:40:20.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-12-15T02:51:59.000Z (about 1 year ago)
• Last Synced: 2023-12-15T03:56:18.314Z (about 1 year ago)
• Language: JavaScript
• Size: 43 KB
• Stars: 1
• Watchers: 6
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Helix Actions - Page Speed Insights (PSI)

## Status

[![codecov](https://codecov.io/gh/adobe-rnd/helix-psi-github-action/branch/main/graph/badge.svg?token=N7RBLVWRSA)](https://codecov.io/gh/adobe-rnd/helix-psi-github-action)

## About

The Helix PSI Action is designed to look at an incoming PR, audit it against the Page Speed Insights API, and report the results. If any threshold is not reached, the action will run a second time.

## Usage

### Requirements

1. A Helix Pages (`hlx3` to be exact) repository.

2. A Google Page Speed Insights API Key. Get your own [here](https://developers.google.com/speed/docs/insights/v5/get-started).

### Sample Workflow

```yml

name: Run Helix PSI Audit

on:

  pull_request:

    types: [opened, synchronize, reopened, edited]

    branches:

      - main

jobs:

  action:

    runs-on: ubuntu-latest

    steps:

      - name: Use repo PSI action

        uses: adobe-rnd/helix-psi-github-action@main

        with:

          psi-key: ${{ secrets.PSI_KEY }}

```

### Optional inputs

For a full list of optional inputs for your workflow, please see [action.yml](https://github.com/adobe-rnd/helix-psi-github-action/blob/main/action.yml).

## Running tests

The tests do hit the Page Speed Insights API. To run them locally:

```bash

PSI_KEY='{{YOUR_PSI_API_KEY}}' npm run test

```