README.md

GitHub Action: Check - URL - Lighthouse

---

Overview

Action to run Lighthouse audits on given URL. The action always sends User-Agent: hoverkraft-tech-url-lighthouse-action when making requests.

Usage

- uses: hoverkraft-tech/ci-github-publish/actions/check/url-lighthouse@b56be562f38e0e3e712f09691a8fe930aae9db1b # 0.22.0
  with:
    # The URL to audit using Lighthouse.
    # This input is required.
    url: ""

    # The path to the performance budget file. See https://web.dev/articles/use-lighthouse-for-performance-budgets.
    # Default: `./budget.json`
    budget-path: ./budget.json

    # Optional Authorization header used to access private URLs.
    # Example: `Bearer xxx...`, `token xxx...`
    authorization: ""

Inputs

Input	Description	Required	Default
url	The URL to audit using Lighthouse.	true	-
budget-path	The path to the performance budget file. See https://web.dev/articles/use-lighthouse-for-performance-budgets.	false	./budget.json
authorization	Optional Authorization header used to access private URLs.	false	-
	Example: Bearer xxx..., token xxx...

Outputs

Output	Description
report-url	The URL to the Lighthouse report artifact.
report-summary	Summary of the Lighthouse report.

Contributing

Contributions are welcome! Please see the contributing guidelines for more details.

License

This project is licensed under the MIT License.

SPDX-License-Identifier: MIT

Copyright © 2026 hoverkraft

For more details, see the license.

---

This documentation was automatically generated by CI Dokumentor.