deployments

Creates, updates, deletes, gets or lists a deployments resource.

Overview

Name	deployments
Type	Resource
Id	github.repos.deployments

Fields

The following fields are returned by SELECT queries:

get_deployment

Response

Name	Datatype	Description
id	integer (int64)	Unique identifier of the deployment
node_id	string	(example: MDEwOkRlcGxveW1lbnQx)
created_at	string (date-time)	(example: 2012-07-20T01:19:13Z)
creator	object	A GitHub user. (title: Simple User)
description	string	(example: Deploy request from hubot)
environment	string	Name for the target deployment environment. (example: production)
original_environment	string	(example: staging)
payload	object
performed_via_github_app	object	GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. (title: GitHub app)
production_environment	boolean	Specifies if the given environment is one that end-users directly interact with. Default: false.
ref	string	The ref to deploy. This can be a branch, tag, or sha. (example: topic-branch)
repository_url	string (uri)	(example: https://api.github.com/repos/octocat/example)
sha	string	(example: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d)
statuses_url	string (uri)	(example: https://api.github.com/repos/octocat/example/deployments/1/statuses)
task	string	Parameter to specify a task to execute (example: deploy)
transient_environment	boolean	Specifies if the given environment is will no longer exist at some point in the future. Default: false.
updated_at	string (date-time)	(example: 2012-07-20T01:19:13Z)
url	string (uri)	(example: https://api.github.com/repos/octocat/example/deployments/1)

list_deployments

Response

Name	Datatype	Description
id	integer (int64)	Unique identifier of the deployment
node_id	string	(example: MDEwOkRlcGxveW1lbnQx)
created_at	string (date-time)	(example: 2012-07-20T01:19:13Z)
creator	object	A GitHub user. (title: Simple User)
description	string	(example: Deploy request from hubot)
environment	string	Name for the target deployment environment. (example: production)
original_environment	string	(example: staging)
payload	object
performed_via_github_app	object	GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. (title: GitHub app)
production_environment	boolean	Specifies if the given environment is one that end-users directly interact with. Default: false.
ref	string	The ref to deploy. This can be a branch, tag, or sha. (example: topic-branch)
repository_url	string (uri)	(example: https://api.github.com/repos/octocat/example)
sha	string	(example: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d)
statuses_url	string (uri)	(example: https://api.github.com/repos/octocat/example/deployments/1/statuses)
task	string	Parameter to specify a task to execute (example: deploy)
transient_environment	boolean	Specifies if the given environment is will no longer exist at some point in the future. Default: false.
updated_at	string (date-time)	(example: 2012-07-20T01:19:13Z)
url	string (uri)	(example: https://api.github.com/repos/octocat/example/deployments/1)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_deployment	select	owner, repo, deployment_id
list_deployments	select	owner, repo	sha, ref, task, environment, per_page, page	Simple filtering of deployments is available via query parameters:
create_deployment	insert	owner, repo, ref		Deployments offer a few configurable parameters with certain defaults. The ref parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them before we merge a pull request. The environment parameter allows deployments to be issued to different runtime environments. Teams often have multiple environments for verifying their applications, such as production, staging, and qa. This parameter makes it easier to track which environments have requested deployments. The default environment is production. The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If the ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will return a failure response. By default, commit statuses for every submitted context must be in a success state. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do not require any contexts or create any commit statuses, the deployment will always succeed. The payload parameter is available for any extra information that a deployment system might need. It is a JSON text field that will be passed on when a deployment event is dispatched. The task parameter is used by the deployment system to allow different execution paths. In the web world this might be deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an application with debugging enabled. Merged branch response: You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating a deployment. This auto-merge happens when: * Auto-merge option is enabled in the repository * Topic branch does not include the latest changes on the base branch, which is master in the response example * There are no merge conflicts If there are no new commits in the base branch, a new request to create a deployment should give a successful response. Merge conflict response: This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't be merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts. Failed commit status checks: This error happens when the required_contexts parameter indicates that one or more contexts need to have a success status for the commit to be deployed, but one or more of the required contexts do not have a state of success. OAuth app tokens and personal access tokens (classic) need the repo or repo_deployment scope to use this endpoint.
delete_deployment	delete	owner, repo, deployment_id		If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. To set a deployment as inactive, you must: * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. * Mark the active deployment as inactive by adding any non-successful deployment status. For more information, see "Create a deployment" and "Create a deployment status." OAuth app tokens and personal access tokens (classic) need the repo or repo_deployment scope to use this endpoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
deployment_id	integer	deployment_id parameter
owner	string	The account owner of the repository. The name is not case sensitive.
repo	string	The name of the repository without the .git extension. The name is not case sensitive.
environment	string	The name of the environment that was deployed to (e.g., staging or production).
page	integer	The page number of the results to fetch. For more information, see "Using pagination in the REST API."
per_page	integer	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
ref	string	The name of the ref. This can be a branch, tag, or SHA.
sha	string	The SHA recorded at creation time.
task	string	The name of the task for the deployment (e.g., deploy or deploy:migrations).

SELECT examples

get_deployment

Response

SELECT
id,
node_id,
created_at,
creator,
description,
environment,
original_environment,
payload,
performed_via_github_app,
production_environment,
ref,
repository_url,
sha,
statuses_url,
task,
transient_environment,
updated_at,
url
FROM github.repos.deployments
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
AND deployment_id = '{{ deployment_id }}' -- required
;

list_deployments

Simple filtering of deployments is available via query parameters:

SELECT
id,
node_id,
created_at,
creator,
description,
environment,
original_environment,
payload,
performed_via_github_app,
production_environment,
ref,
repository_url,
sha,
statuses_url,
task,
transient_environment,
updated_at,
url
FROM github.repos.deployments
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
AND sha = '{{ sha }}'
AND ref = '{{ ref }}'
AND task = '{{ task }}'
AND environment = '{{ environment }}'
AND per_page = '{{ per_page }}'
AND page = '{{ page }}'
;

INSERT examples

create_deployment

Deployments offer a few configurable parameters with certain defaults.

The ref parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them
before we merge a pull request.

The environment parameter allows deployments to be issued to different runtime environments. Teams often have
multiple environments for verifying their applications, such as production, staging, and qa. This parameter
makes it easier to track which environments have requested deployments. The default environment is production.

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If
the ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,
the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will
return a failure response.

By default, commit statuses for every submitted context must be in a success
state. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to
specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do
not require any contexts or create any commit statuses, the deployment will always succeed.

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text
field that will be passed on when a deployment event is dispatched.

The task parameter is used by the deployment system to allow different execution paths. In the web world this might
be deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an
application with debugging enabled.

Merged branch response:

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating
a deployment. This auto-merge happens when:
* Auto-merge option is enabled in the repository
* Topic branch does not include the latest changes on the base branch, which is master in the response example
* There are no merge conflicts

If there are no new commits in the base branch, a new request to create a deployment should give a successful
response.

Merge conflict response:

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't
be merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

Failed commit status checks:

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success
status for the commit to be deployed, but one or more of the required contexts do not have a state of success.

OAuth app tokens and personal access tokens (classic) need the repo or repo_deployment scope to use this endpoint.

INSERT INTO github.repos.deployments (
ref,
task,
auto_merge,
required_contexts,
payload,
environment,
description,
transient_environment,
production_environment,
owner,
repo
)
SELECT 
'{{ ref }}' /* required */,
'{{ task }}',
{{ auto_merge }},
'{{ required_contexts }}',
'{{ payload }}',
'{{ environment }}',
'{{ description }}',
{{ transient_environment }},
{{ production_environment }},
'{{ owner }}',
'{{ repo }}'
RETURNING
id,
node_id,
created_at,
creator,
description,
environment,
original_environment,
payload,
performed_via_github_app,
production_environment,
ref,
repository_url,
sha,
statuses_url,
task,
transient_environment,
updated_at,
url
;

Manifest

# Description fields are for documentation purposes
- name: deployments
props:
  - name: owner
    value: "{{ owner }}"
    description: Required parameter for the deployments resource.
  - name: repo
    value: "{{ repo }}"
    description: Required parameter for the deployments resource.
  - name: ref
    value: "{{ ref }}"
    description: |
      The ref to deploy. This can be a branch, tag, or SHA.
  - name: task
    value: "{{ task }}"
    description: |
      Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).
    default: deploy
  - name: auto_merge
    value: {{ auto_merge }}
    description: |
      Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.
    default: true
  - name: required_contexts
    value:
      - "{{ required_contexts }}"
    description: |
      The [status](https://docs.github.com/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.
  - name: payload
    value: "{{ payload }}"
    description: |
      JSON payload with extra information about the deployment.
    default: 
  - name: environment
    value: "{{ environment }}"
    description: |
      Name for the target deployment environment (e.g., `production`, `staging`, `qa`).
    default: production
  - name: description
    value: "{{ description }}"
    description: |
      Short description of the deployment.
    default: 
  - name: transient_environment
    value: {{ transient_environment }}
    description: |
      Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false`
    default: false
  - name: production_environment
    value: {{ production_environment }}
    description: |
      Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise.

DELETE examples

delete_deployment

If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.

To set a deployment as inactive, you must:

* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.
* Mark the active deployment as inactive by adding any non-successful deployment status.

For more information, see "Create a deployment" and "Create a deployment status."

OAuth app tokens and personal access tokens (classic) need the repo or repo_deployment scope to use this endpoint.

DELETE FROM github.repos.deployments
WHERE owner = '{{ owner }}' --required
AND repo = '{{ repo }}' --required
AND deployment_id = '{{ deployment_id }}' --required
;