커밋

Enterprise Cloud

Enterprise Server

Enterprise Server 3.10

Enterprise Server 3.6

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

모든 GitHub 문서는 오픈 소스입니다. 잘못되었거나 명확하지 않은 사항이 있나요? 끌어오기 요청을 제출하세요.

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

GitHub 여정 중 어디에 있든 도움이 됩니다.

다음 중 하나일 수 있습니다.

이름

모든 {{ 이름 }} 가이드

{{ 이름 }} 학습 경로

작업

GitHub에서 이러한 변경 사항을 엔터프라이즈에 롤아웃 시작

검색어를 입력하여 GitHub Docs에서 찾습니다.

커밋 - GitHub AE Docs

REST API를 사용하여 커밋과 상호 작용합니다.

English

Simplified Chinese

Spanish

Portuguese

Russian

Japanese

French

German

Korean

빠른 시작

GitHub API 정보

REST API의 리소스

미디어 유형

인증

API 자격 증명 보안 유지

문제 해결

라이브러리

이슈 이벤트 유형

GitHub 이벤트 유형

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

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

GitHub 앱에 대한 권한

개요

API 사용

JavaScript를 사용하여 스크립트

사용자에 대한 리소스 검색

배포 제공

데이터를 그래프로 렌더링

주석 작업

페이지 구분

CI 서버 빌드

모범 사례

시작 - Git 데이터베이스

시작 - 검사

비밀 암호화

Guides

Artifacts

사용 권한

비밀

자체 호스팅 실행기 그룹

자체 호스팅 실행기

워크플로 작업

워크플로 실행

워크플로

동작

이벤트

Feeds

Notifications

별 지정

확인

활동

GitHub 앱

설치

OAuth 권한 부여

웹후크

분기

보호된 분기

실행 확인

체크 스위트

코드 검사

사용 규정

협력자

초대

{b>커밋 주석<b}

커밋 상태

키 배포

배포 분기 정책

배포

환경

배포 상태

이모지

관리자 통계

알림

감사 로그

전역 webhook

라이선스

조직

사전 수신 환경

사용자

엔터프라이즈 관리

Gists

주석

Blob

참조

Trees

Git 데이터베이스

gitignore

문제

담당자

레이블

마일스톤

시간

마크다운

메타

통계

메트릭

마이그레이션

멤버

외부 협력자

페이지

Boards

카드

Project boards

가져오기

메모 검토

요청 검토

검토

속도 제한

{b>반응<b}

릴리스

릴리스 자산

자동 링크

콘텐츠

포크

Git LFS

리포지토리

Search

비밀 검사

Teams

토론 의견

토론

외부 그룹

팔로워

GPG 키

Git SSH 키

리포지토리 웹후크 구성

리포지토리 Webhook 전송

리포지토리 웹후크

Commit

<p><strong>Signature verification object</strong></p>
<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>






























<table><thead><tr><th scope="col">Name</th><th scope="col">Type</th><th scope="col">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>
<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>





























































<table><thead><tr><th scope="col">Value</th><th scope="col">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The "signing" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>

<p>The account owner of the repository. The name is not case sensitive.</p>

owner

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

repo

<p>SHA or branch to start listing commits from. Default: the repository’s default branch (usually <code>main</code>).</p>

<p>Only commits containing this file path will be returned.</p>

path

<p>GitHub username or email address to use to filter by commit author.</p>

author

<p>GitHub username or email address to use to filter by commit committer.</p>

committer

<p>Only show results that were last updated after the given time. This is a timestamp in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a> format: <code>YYYY-MM-DDTHH:MM:SSZ</code>.</p>

since

<p>Only commits before this date will be returned. This is a timestamp in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a> format: <code>YYYY-MM-DDTHH:MM:SSZ</code>.</p>

until

<p>The number of results per page (max 100).</p>

per_page

<p>Page number of the results to fetch.</p>

page

List commits

branch_5

Branch Short

<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href="https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products">GitHub's products</a> in the GitHub Help documentation.</p>
<p>Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch.</p>

commit_sha

<p>Validation failed, or the endpoint has been spammed.</p>

List branches for HEAD commit

v1.0

Amazing new feature

Pull Request Simple

<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.</p>
<p>To list the open or merged pull requests associated with a branch, you can set the <code>commit_sha</code> parameter to the branch name.</p>

List pull requests associated with a commit

Monalisa Octocat

<p>Returns the contents of a single commit reference. You must have <code>read</code> access for the repository to use this endpoint.</p>
<p><strong>Note:</strong> If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.</p>
<p>You can pass the appropriate <a href="https://docs.github.com/github-ae@latest/rest/overview/media-types/#commits-commit-comparison-and-pull-requests">media type</a> to  fetch <code>diff</code> and <code>patch</code> formats. Diffs with binary data will have no <code>patch</code> property.</p>
<p>To return only the SHA-1 hash of the commit reference, you can provide the <code>sha</code> custom <a href="https://docs.github.com/github-ae@latest/rest/overview/media-types/#commits-commit-comparison-and-pull-requests">media type</a> in the <code>Accept</code> header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.</p>
<p><strong>Signature verification object</strong></p>
<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>






























<table><thead><tr><th scope="col">Name</th><th scope="col">Type</th><th scope="col">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>
<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>





























































<table><thead><tr><th scope="col">Value</th><th scope="col">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The "signing" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>

<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see "<a href="https://git-scm.com/book/en/v2/Git-Internals-Git-References">Git References</a>" in the Git documentation.</p>

Get a commit

https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e

Commit Comparison

<p>Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "<a href="https://docs.github.com/github-ae@latest/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories">Understanding connections between repositories</a>."</p>
<p>This endpoint is equivalent to running the <code>git log BASE..HEAD</code> command, but it returns commits in a different order. The <code>git log BASE..HEAD</code> command returns commits in reverse chronological order, whereas the API returns commits in chronological order. You can pass the appropriate <a href="https://docs.github.com/github-ae@latest/rest/overview/media-types/#commits-commit-comparison-and-pull-requests">media type</a> to fetch diff and patch formats.</p>
<p>The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a <code>renamed</code> status have a <code>previous_filename</code> field showing the previous filename of the file, and files with a <code>modified</code> status have a <code>patch</code> field showing the changes made to the file.</p>
<p>When calling this endpoint without any paging parameter (<code>per_page</code> or <code>page</code>), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.</p>
<p><strong>Working with large comparisons</strong></p>
<p>To process a response with a large number of commits, use a query parameter (<code>per_page</code> or <code>page</code>) to paginate the results. When using pagination:</p>
<ul>
<li>The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.</li>
<li>The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.</li>
</ul>
<p>For more information on working with pagination, see "<a href="https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api">Using pagination in the REST API</a>."</p>
<p><strong>Signature verification object</strong></p>
<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The <code>verification</code> object includes the following fields:</p>






























<table><thead><tr><th scope="col">Name</th><th scope="col">Type</th><th scope="col">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>
<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>





























































<table><thead><tr><th scope="col">Value</th><th scope="col">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The "signing" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>

<p>The base branch and head branch to compare. This parameter expects the format <code>BASE...HEAD</code>. Both must be branch names in <code>repo</code>. To compare with a branch that exists in a different repository in the same network as <code>repo</code>, the <code>basehead</code> parameter expects the format <code>USERNAME:BASE...USERNAME:HEAD</code>.</p>