README.md

GitHub Action: Deployment - Read deployment

---

Overview

Action to retrieve some deployment information.

Usage

- uses: hoverkraft-tech/ci-github-publish/actions/deployment/read@b56be562f38e0e3e712f09691a8fe930aae9db1b # 0.22.0
  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 }}

    # GitHub Token to get the deployment information.
    # Permissions:
    # - deployments: read
    # See https://docs.github.com/en/rest/deployments/deployments?apiVersion=2022-11-28#get-a-deployment.
    #
    # 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 }}
github-token	GitHub Token to get the deployment information.	false	${{ github.token }}
	Permissions:
	- deployments: read
	See https://docs.github.com/en/rest/deployments/deployments?apiVersion=2022-11-28#get-a-deployment.

Outputs

Output	Description
environment	The environment of the deployment
url	The URL of the deployment

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.