README.md

GitHub Action: Deployment - Update deployment

---

Overview

Action to update a deployment. Create a new status.

Permissions

Set permissions to write deployments.

permissions:
  actions: read
  deployments: write

Usage

- uses: hoverkraft-tech/ci-github-publish/actions/deployment/update@b2562b46714e535a0113f90f554b55e1248212c1 # 0.26.3
  with:
    # The ID of the deployment to update
    # This input is required.
    deployment-id: ""

    # The repository where the deployment was made
    # Default: `${{ github.event.repository.name }}`
    repository: ${{ github.event.repository.name }}

    # The state of the deployment
    # This input is required.
    state: ""

    # The description of the deployment
    description: ""

    # The URL of the deployment
    url: ""

    # Update the log URL of the deployment
    # Default: `true`
    update-log-url: "true"

    # GitHub Token to update the deployment.
    # Permissions:
    # - actions: read
    # - deployments: 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
deployment-id	The ID of the deployment to update	true	-
repository	The repository where the deployment was made	false	${{ github.event.repository.name }}
state	The state of the deployment	true	-
description	The description of the deployment	false	-
url	The URL of the deployment	false	-
update-log-url	Update the log URL of the deployment	false	true
github-token	GitHub Token to update the deployment.	false	${{ github.token }}
	Permissions:
	- actions: read
	- deployments: write
	See https://docs.github.com/en/rest/deployments/statuses?apiVersion=2022-11-28#create-a-deployment-status.

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.