deploy-finish.md

GitHub Reusable Workflow: Deploy - Finish

---

Overview

Reusable workflow that performs the end of a deployment.

What this workflow does:

• If the deployment exposes a URL, run deploy checks:
• Update the GitHub deployment status (success or failure).
• Publish a human-readable deployment summary using the deploy/report action. See report.
  • Lighthouse report URL if available.
  • Extra information if provided.

Permissions

• actions: read
• contents: read
• deployments: write
• id-token: write
• issues: write
• pull-requests: write

Usage

name: Deploy - Finish
on:
  push:
    branches:
      - main
permissions: {}
jobs:
  deploy-finish:
    uses: hoverkraft-tech/ci-github-publish/.github/workflows/deploy-finish.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"]'

      # Deployment ID to use for the deployment.
      # See https://docs.github.com/en/rest/deployments/deployments?apiVersion=2022-11-28#list-deployments.
      #
      # This input is required.
      deployment-id: ""

      # 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

      # Extra information to send to the deployment summary.
      # Should be a JSON object.
      extra: ""

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.
deployment-id	Deployment ID to use for the deployment.	true	string	-
	See https://docs.github.com/en/rest/deployments/deployments?apiVersion=2022-11-28#list-deployments.
budget-path	Path to the budget file to use for the Lighthouse check.	false	string	./budget.json
	See url-lighthouse.
extra	Extra information to send to the deployment summary.	false	string	-
	Should be a JSON object.

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.