Skip to content

README.md

Latest commit

 

History

History
138 lines (94 loc) · 5.54 KB

README.md

File metadata and controls

138 lines (94 loc) · 5.54 KB

Icon GitHub Action: Deployment - Get finished deployment

Deployment - Get finished deployment

Marketplace Release License Stars PRs Welcome

Overview

Waits for a GitHub deployment to reach a terminal state and returns its latest status and metadata.

This action polls the GitHub Deployment Status API for the provided deployment ID until it observes a terminal state (success, failure or error), or until the specified timeout (in seconds) elapses.

It uses exponential backoff between checks to reduce API pressure. The action sets outputs with the final deployment state, the environment name and the environment URL (if present).

Permissions

Set permissions to read deployments.

permissions:
  actions: read
  deployments: read

Usage

- uses: hoverkraft-tech/ci-github-publish/actions/deployment/get-finished@2c8e24b416226074aea1e240468f043edefc5760 # 0.23.2
  with:
    # The ID of the GitHub deployment to wait for (numeric ID)
    # This input is required.
    deployment-id: ""

    # Maximum time to wait for a terminal deployment status, in seconds
    # Default: `240`
    timeout: "240"

    # If "true", the action will not mark the step as failed when the deployment finishes with a non-success terminal state
    # (for example `failure` or `error`).
    # When `false` (default), the step fails if the final deployment status is not `success`.
    #
    # Default: `false`
    allow-failure: "false"

Inputs

Input Description Required Default
deployment-id The ID of the GitHub deployment to wait for (numeric ID) true -
timeout Maximum time to wait for a terminal deployment status, in seconds false 240
allow-failure If "true", the action will not mark the step as failed when the deployment finishes with a non-success terminal state false false
(for example failure or error).
When false (default), the step fails if the final deployment status is not success.

Outputs

Output Description
status The final terminal state of the deployment (e.g. success, failure, error)
url The environment URL associated with the deployment (if provided by the status)
environment The target environment name for the deployment (e.g. production, staging)

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.