https://github.com/jakepartusch/psi-action
A GitHub action that utilizes Google's Page Speed Insights to generate a performance report
https://github.com/jakepartusch/psi-action
Last synced: 4 months ago
JSON representation
A GitHub action that utilizes Google's Page Speed Insights to generate a performance report
- Host: GitHub
- URL: https://github.com/jakepartusch/psi-action
- Owner: JakePartusch
- Created: 2020-01-07T14:34:57.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-03T05:12:19.000Z (over 2 years ago)
- Last Synced: 2025-03-16T06:11:36.383Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 10.9 MB
- Stars: 82
- Watchers: 2
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Page Speed Insights — A GitHub Action 🏎
This action utilizes [Google's Page Speed Insights](https://developers.google.com/speed/docs/insights/v5/about) 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](https://docs.github.com/en/actions/reference/encrypted-secrets). You can request a key [here](https://developers.google.com/speed/docs/insights/v5/get-started)
### `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
```yaml
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 }}
```