README.md

GitHub Action: Deploy - Report

---

Overview

Generate a post-deployment report and update GitHub with the deployment result.

This action collects the workflow run result and builds a human-friendly deployment summary that is written to the GitHub Actions summary (visible in the workflow run UI). The report can include:

• the deployment environment,
• a link to the workflow logs,
• the deployed application URL (if provided),
• an optional list of failed jobs (when the run failed),
• additional key-value pairs passed through the extra input.

When deployment-id and repository are supplied, the action will also update the corresponding GitHub Deployment status (state, description and URL). If triggered by an issue_comment event the action can post (or update) an issue/PR comment and add a reaction to the original comment to provide inline feedback about the deployment.

Permissions

Set permissions to read deployments.

permissions:
  actions: read
  deployments: write

Usage

- uses: hoverkraft-tech/ci-github-publish/actions/deploy/report@b56be562f38e0e3e712f09691a8fe930aae9db1b # 0.22.0
  with:
    # The repository where the deployment was made
    # Default: `${{ github.event.repository.name }}`
    repository: ${{ github.event.repository.name }}

    # Deployment ID to report.
    deployment-id: ""

    # Environment where the deployment was made.
    environment: ""

    # URL where the deployment is available.
    url: ""

    # Extra outputs to be included in the summary. JSON object with key-value pairs.
    extra: ""

    # GitHub Token to update the deployment.
    # Permissions:
    # - actions: read
    # - deployments: write
    # - issues: write
    # - pull-requests: write
    # See https://docs.github.com/en/rest/deployments/statuses?apiVersion=2022-11-28#create-a-deployment-status.
    #
    # Default: `${{ github.token }}`
    github-token: ${{ github.token }}

Inputs

Input	Description	Required	Default
repository	The repository where the deployment was made	false	${{ github.event.repository.name }}
deployment-id	Deployment ID to report.	false	-
environment	Environment where the deployment was made.	false	-
url	URL where the deployment is available.	false	-
extra	Extra outputs to be included in the summary. JSON object with key-value pairs.	false	-
github-token	GitHub Token to update the deployment.	false	${{ github.token }}
	Permissions:
	- actions: read
	- deployments: write
	- issues: write
	- pull-requests: write
	See https://docs.github.com/en/rest/deployments/statuses?apiVersion=2022-11-28#create-a-deployment-status.

Outputs

Output	Description
url	URL of the deployed application

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.