deploy-checks.md

GitHub Reusable Workflow: Deploy - Checks

---

Overview

Reusable workflow that performs deployment checks. It runs quick health and performance checks.

What this workflow does:

• URL ping check. See Ping check.
• Lighthouse audit. See Lighthouse check.

Permissions

• contents: read
• id-token: write

Usage

name: Deploy - Checks
on:
  push:
    branches:
      - main
permissions: {}
jobs:
  deploy-checks:
    uses: hoverkraft-tech/ci-github-publish/.github/workflows/deploy-checks.yml@b56be562f38e0e3e712f09691a8fe930aae9db1b # 0.22.0
    permissions: {}
    with:
      # JSON array of runner(s) to use.
      # See https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job.
      #
      # Default: `["ubuntu-latest"]`
      runs-on: '["ubuntu-latest"]'

      # The URL to check.
      # This input is required.
      url: ""

      # Path to the budget file to use for the Lighthouse check.
      # See [`url-lighthouse`](../../actions/check/url-lighthouse/README.md).
      #
      # Default: `./budget.json`
      budget-path: ./budget.json

      # Whether to print a summary of the checks.
      # Default: `true`
      print-summary: true

Inputs

Workflow Call Inputs

Input	Description	Required	Type	Default
runs-on	JSON array of runner(s) to use.	false	string	["ubuntu-latest"]
	See https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job.
url	The URL to check.	true	string	-
budget-path	Path to the budget file to use for the Lighthouse check.	false	string	./budget.json
	See url-lighthouse.
print-summary	Whether to print a summary of the checks.	false	boolean	true

Outputs

Output	Description
summary	Summary of the checks.
	This will include the results of the URL ping and Lighthouse checks.
	Example:
	{ "ping": { "statusCode": 200, "attemptCount": 3 }, "lighthouse": { "reportUrl": "https://example.com/lighthouse-report.html",
 "reportSummary": { "performance": 0.9, "accessibility": 0.95 } } }

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-tech

For more details, see the license.

---

This documentation was automatically generated by CI Dokumentor.