Create a deployment

Deployments offer a few configurable parameters with certain defaults.

The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server 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.

Users with repo or repo_deployment scopes can create a deployment for a given ref.

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.

curl --location --request POST 'https://api.github.com/repos///deployments' \ --header 'Content-Type: application/json' \ --data-raw '{ "auto_merge": false, "description": "Deploy request from hubot", "payload": "{ \"deploy\": \"migrate\" }", "ref": "topic-branch", "required_contexts": [ "ci/janky", "security/brakeman" ] }'

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

owner

string

必需

repo

string

必需

Body 参数application/json

auto_merge

boolean

可选

Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.

默认值:

true

description

string | null

可选

Short description of the deployment.

默认值:

environment

string

可选

Name for the target deployment environment (e.g., production, staging, qa).

默认值:

production

payload

可选

One of

object

string

额外字段

integer | number | string | boolean

可选

production_environment

boolean

可选

Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.
Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

ref

string

必需

The ref to deploy. This can be a branch, tag, or SHA.

required_contexts

array[string]

可选

The status 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.

task

string

可选

Specifies a task to execute (e.g., deploy or deploy:migrations).

默认值:

deploy

transient_environment

boolean

可选

Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false
Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

默认值:

false

示例

返回响应

🟢201Response

application/json

Body

A deployment created as the result of an Actions check run from a workflow that references an environment

created_at

string <date-time>

必需

示例值:

2012-07-20T01:19:13Z

description

string | null

必需

示例值:

Deploy request from hubot

environment

string

必需

Name for the target deployment environment.

示例值:

production

integer

必需

Unique identifier of the deployment

示例值:

node_id

string

必需

示例值:

MDEwOkRlcGxveW1lbnQx

original_environment

string

可选

示例值:

staging

performed_via_github_app

null | allOf {1}

可选

object

可选

production_environment

boolean

可选

Specifies if the given environment is one that end-users directly interact with. Default: false.

示例值:

true

repository_url

string <uri>

必需

示例值:

https://api.github.com/repos/octocat/example

statuses_url

string <uri>

必需

示例值:

https://api.github.com/repos/octocat/example/deployments/1/statuses

task

string

必需

Parameter to specify a task to execute

示例值:

deploy

transient_environment

boolean

可选

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

示例值:

true

updated_at

string <date-time>

必需

示例值:

2012-07-20T01:19:13Z

url

string <uri>

必需

示例值:

https://api.github.com/repos/octocat/example/deployments/1

🟢202Merged branch response

🟠409Conflict when there is a merge conflict or the commit's status checks failed

🟠422422

Merged branch response#

Merge conflict response#

Failed commit status checks#

请求参数

返回响应

Merged branch response

Merge conflict response

Failed commit status checks