Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stefafafan/psi-action
A GitHub Action for PageSpeed Insights
https://github.com/stefafafan/psi-action
github-actions pagespeed-insights
Last synced: 25 days ago
JSON representation
A GitHub Action for PageSpeed Insights
- Host: GitHub
- URL: https://github.com/stefafafan/psi-action
- Owner: stefafafan
- License: mit
- Created: 2022-12-21T11:36:36.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-11T19:01:51.000Z (over 1 year ago)
- Last Synced: 2024-04-24T13:17:30.706Z (8 months ago)
- Topics: github-actions, pagespeed-insights
- Language: TypeScript
- Homepage:
- Size: 6.34 MB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# psi-action
psi-action is a GitHub Action that outputs [PageSpeed Insights](https://pagespeed.web.dev/) values for the next steps of a workflow. This action is similar to [JakePartusch/psi-action](https://github.com/JakePartusch/psi-action), but different in that this actually outputs the values for further use in the workflow.
## Inputs
- `url`: The URL to fetch PageSpeed Insights results.
- `key`: API Key for the PageSpeed Insights API.
- `strategy`: Strategy to fetch PageSpeed Insights results. "mobile" or "desktop".
## Outputs
- `score`: Overall score of the url. Maximum is 100.
- `first-contentful-paint`: First Contentful Paint (FCP) in milliseconds.
- `first-input-delay`: First Input Delay (FID) in milliseconds.
- `cumulative-layout-shift`: Cumulative Layout Shift (CLS) score.
- `largest-contentful-paint`: Largest Contentful Paint (LCP) in milliseconds.
- `speed-index`: Speed Index score. Maximum is 100.
- `time-to-interactive`: Time to Interactive score. Maximum is 100.
- `total-blocking-time`: Total Blocking Time score. Maximum is 100.
## Example Usage
```yaml
- id: psi
uses: stefafafan/psi-action@v1
with:
url: 'https://example.com/'
key: ${{ secrets.API_KEY }}
strategy: 'mobile'
- name: echo score
run: echo "Score: ${{ steps.psi.outputs.score }}"
```
## Contributing
See the [Contribution Guide](https://github.com/stefafafan/psi-action/blob/main/CONTRIBUTING.md).
## Author
stefafafan ([GitHub](https://github.com/stefafafan), [Twitter](https://twitter.com/stefafafan))