部署

Enterprise Cloud

Enterprise Server 3.10

Enterprise Server 3.11

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

所有 GitHub 文档都是开源的。 看到错误或不清楚的内容了吗？ 提交拉取请求。

帮助我们创建出色的文档！

操作

输入搜索词以在 GitHub 文档中找到它。

部署 - GitHub 文档

使用 REST API 创建和删除部署密钥、部署和部署环境。

快速入门

比较 GitHub 的 API

REST API 中的资源

Rate limits

API 版本

媒体类型

身份验证

确保 API 凭据安全

故障排除

Libraries

OpenAPI 描述

议题事件类型

GitHub 事件类型

适用于 GitHub Apps 安装令牌的终结点

适用于 GitHub Apps 用户令牌的终结点

细化 PAT 的终结点

GitHub 应用的权限

细化 PAT 的权限

重大更改

概述

使用 API

使用 JavaScript 编写脚本

使用 Ruby 编写脚本

为用户发现资源

交付部署

将数据渲染为图形

处理注释

分页

构建 CI 服务器

最佳实践

入门 - Git 数据库

开始 - 检查

加密机密

Guides

Artifacts

缓存

OIDC

权限

机密

自托管运行程序

变量

工作流程作业

工作流运行

工作流

事件

通知

标星

关注中

活动

GitHub 应用

安装

市场

OAuth 授权

Webhook

应用

计费

分支

受保护的分支

检查运行

检查套件

检查

教室

代码扫描

行为准则

Codespaces

组织

组织机密

存储库机密

用户机密

协作者

邀请

提交

提交注释

提交状态

Copilot business

Copilot

警报

Dependabot

依赖项检查

依赖项提交

软件材料清单 (SBOM)

依赖项关系图

部署密钥

部署分支策略

环境

保护规则

部署状态

表情符号

Gists

注释

Blob

reference

标记

Trees

Git 数据库

Gitignore

存储库

用户

交互

问题

受理人

里程碑

时间线

许可证

Markdown

元数据

社区

统计信息

交通

指标

源导入

迁移

阻止用户

Custom properties

成员

组织角色

外部协作者

个人访问令牌

规则套件

规则

安全经理

Boards

卡片

Projects (classic)

拉取

评价注释

审查请求

审阅

速率限制

反应

发行版本

发布资产

自动链接

前叉

搜索

机密扫描

全局安全公告

存储库安全公告

安全通知

Teams

讨论评论

讨论

电子邮件

关注者

GPG 密钥

Git SSH 密钥

SSH 签名密钥

社交帐户

A request for a specific ref(branch,sha,tag) to be deployed

Deployment

Simple filtering of deployments is available via query parameters:

The account owner of the repository. The name is not case sensitive.

owner

The name of the repository without the <code>.git</code> extension. The name is not case sensitive.

repo

The SHA recorded at creation time.

The name of the ref. This can be a branch, tag, or SHA.

The name of the task for the deployment (e.g., <code>deploy</code> or <code>deploy:migrations</code>).

task

The name of the environment that was deployed to (e.g., <code>staging</code> or <code>production</code>).

environment

The number of results per page (max 100).

per_page

Page number of the results to fetch.

page

List deployments

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

Specifies a task to execute (e.g., <code>deploy</code> or <code>deploy:migrations</code>).

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

auto_merge

The <a href="https://docs.github.com/rest/commits/statuses">status</a> 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.

required_contexts

JSON payload with extra information about the deployment.

payload

Name for the target deployment environment (e.g., <code>production</code>, <code>staging</code>, <code>qa</code>).

Short description of the deployment.

description

Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: <code>false</code>

transient_environment

Specifies if the given environment is one that end-users directly interact with. Default: <code>true</code> when <code>environment</code> is <code>production</code> and <code>false</code> otherwise.

production_environment

Name for the target deployment environment.

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

Deployments offer a few configurable parameters with certain defaults.
The <code>ref</code> 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 <code>environment</code> parameter allows deployments to be issued to different runtime environments. Teams often have
multiple environments for verifying their applications, such as <code>production</code>, <code>staging</code>, and <code>qa</code>. This parameter
makes it easier to track which environments have requested deployments. The default environment is <code>production</code>.
The <code>auto_merge</code> 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, <a href="https://docs.github.com/rest/commits/statuses">commit statuses</a> for every submitted context must be in a <code>success</code>
state. The <code>required_contexts</code> parameter allows you to specify a subset of contexts that must be <code>success</code>, 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 <code>payload</code> 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 <code>task</code> parameter is used by the deployment system to allow different execution paths. In the web world this might
be <code>deploy:migrations</code> 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 <code>repo</code> or <code>repo_deployment</code> 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:
<ul>
<li>Auto-merge option is enabled in the repository</li>
<li>Topic branch does not include the latest changes on the base branch, which is <code>master</code> in the response example</li>
<li>There are no merge conflicts</li>
</ul>
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 <code>auto_merge</code> option is enabled and when the default branch (in this case <code>master</code>), can't
be merged into the branch that's being deployed (in this case <code>topic-branch</code>), due to merge conflicts.
Failed commit status checks:
This error happens when the <code>required_contexts</code> parameter indicates that one or more contexts need to have a <code>success</code>
status for the commit to be deployed, but one or more of the required contexts do not have a state of <code>success</code>.

Create a deployment