Psi Gh Action

screenshot of Psi Gh Action

Github Action to generate web performance report for JAMStack using PageSpeedInsight

Overview

If you're looking to enhance your static website's performance, the PSI-GH-Action is an essential tool that effortlessly integrates with GitHub Actions. Designed specifically for generating web performance reports for JAMStack applications using PageSpeed Insights, this action simplifies the process of monitoring your website's performance over time. With a straightforward setup, you can provide your readers with instant access to performance metrics directly linked to your personal blog or open-source projects.

This tool not only generates comprehensive reports, but it also ensures that you have a clear understanding of how your website performs across different devices. By automating performance checks, you can focus more on content creation while staying informed on vital performance improvements.

Features

  • Easy Integration: Seamlessly integrates with GitHub Actions to monitor and report your website's performance with minimal setup.
  • Customizable Inputs: Users can specify the API key, URLs, and other test parameters like device type and number of test runs.
  • Automated Reporting: Generates performance reports automatically and can push them to your main branch, streamlining your workflow.
  • Multiple Device Testing: Option to test performance across various devices (default is mobile), ensuring a comprehensive evaluation.
  • Report History Management: Keeps a history of reports by allowing users to define how many should be retained in the repository.
  • Push or Pull Request Options: Offers flexibility to either push reports directly to the branch or create a pull request for manual merging, enhancing control over updates.
  • Scheduled Checks: Best used with a cron scheduler to regularly check performance without triggering on every push, ensuring up-to-date insights.
  • User-friendly Outputs: Generates clear report files that are easy to access, such as LAST_UPDATED.txt and available-reports.json, aiding in quick analysis.