Search⌘ K
AI Features

Deployments

Explore how to deploy applications and manage software releases with GitHub APIs. Learn to create, get, list, and delete deployments in different environments, handle deployment statuses, and understand API interactions to maintain smooth deployment workflows.

Overview

Deployment is a request to deploy resources from one development environment to another to bring them into effective action. These requests can be of any branch, tag, or ID. Deployments minimize the worry of implementation details of various application types. They do so by building a loosely-coupled relation between different deployments.

External services (such as GitLab, Redmine, etc.) can mark deployments with different deployment statuses. The list below shows these status types:

  • error
  • failure
  • pending
  • in_progress
  • queued
  • success

We can add description and log_url optionally to the deployment status for more clarity. The deployment and its status are dispatched by GitHub to third parties that upgrade its ...