배포

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 문서는 오픈 소스입니다. 잘못되었거나 명확하지 않은 사항이 있나요? 끌어오기 요청을 제출하세요.

이러한 문서를 멋지게 만들 수 있도록 도와주세요!

actions

GitHub Docs에서 찾으려면 검색어를 입력하세요.

배포 - GitHub Docs

REST API를 사용하여 배포 키, 배포 및 배포 환경을 만들고 삭제합니다.

빠른 시작

GitHub의 API 비교

REST API의 리소스

트래픽률 제한

API 버전

미디어 유형

인증

해당 API 자격 증명 보안 유지

문제 해결

Libraries

OpenAPI 설명

이슈 이벤트 유형

GitHub 이벤트 유형

GitHub 앱 설치 액세스 토큰에 대한 엔드포인트

GitHub 앱 사용자 토큰에 대한 엔드포인트

세분화된 PAT에 대한 엔드포인트

GitHub 앱에 필요한 권한

세분화된 PAT에 대한 권한

호환성이 손상되는 변경

개요

API 사용

JavaScript를 사용하여 스크립트

Ruby를 사용하여 스크립트

사용자에 대한 리소스 검색

배포 제공

데이터를 그래프로 렌더링

주석 작업

페이지 매김

CI 서버 빌드

모범 사례

시작 - Git 데이터베이스

시작 - 검사

비밀 암호화

Guides

Artifacts

캐시

OIDC

사용 권한

비밀

자체 호스팅 실행기

변수

워크플로 작업

워크플로 실행

워크플로

작업

이벤트

피드

알림

별 지정

확인

활동

GitHub 앱

설치

마켓플레이스

OAuth 권한 부여

Webhooks

결제

분기

보호된 분기

실행 확인

체크 스위트

클래스룸

코드 검사

사용 규정

Codespaces

조직

조직 비밀

머신

리포지토리 비밀

사용자 비밀

협력자

초대

커밋

{b>커밋 주석<b}

커밋 상태

Copilot business

Copilot

경고

Dependabot

종속성 검토

종속성 제출

SBOM(소프트웨어 제품 구성 정보)

종속성 그래프

배포 키

키 배포

배포 분기 정책

환경

보호 규칙

배포 상태

이모지

Gists

설명

Blob

참조

Trees

Git 데이터베이스

gitignore

리포지토리

사용자

상호 작용

이슈

담당자

레이블

마일스톤

시간

라이선스

마크다운

메타

커뮤니티

통계

트래픽

메트릭

원본 가져오기

마이그레이션

사용자 차단

Custom properties

멤버

조직 역할

외부 협력자

개인용 액세스 토큰

규칙 도구 모음

규칙

보안 관리자

패키지

페이지

Boards

카드

Projects (classic)

가져오기

메모 검토

요청 검토

검토

속도 제한

{b>반응<b}

릴리스

릴리스 자산

자동 링크

콘텐츠

포크

Rule Suites

검색

비밀 검사

글로벌 보안 공지

리포지토리 보안 공지

보안 공지

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

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