Commits

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

Toute la documentation GitHub est open source. Vous voyez quelque chose qui n’est pas correct ou qui n’est pas clair ? Envoyez une demande de tirage.

Aidez-nous à rendre ces documents formidables !

De l’aide, où que vous en soyez dans votre parcours sur GitHub.

Peut être

Paramètres du corps de la requête de webhook

Tous les guides {{ name }}

Parcours d’apprentissage {{ name }}

Actions

GitHub a commencé à déployer ces changements pour les entreprises le

Entrez un terme de recherche pour le trouver dans la documentation GitHub.

Commits - GitHub AE Docs

Utilisez l’API REST pour interagir avec des commits.

English

Simplified Chinese

Spanish

Portuguese

Russian

Japanese

French

German

Korean

Démarrage rapide

À propos des API GitHub

Ressources disponibles dans l’API REST

Types de médias

Authentification

Sécurisation des informations d’identification de l’API

Dépannage

Bibliothèques

Types d’événement de problème

Types d’événements GitHub

Points de terminaison pour les jetons d’installation d’application GitHub

Points de terminaison pour les jetons d’utilisateur d’application GitHub

Autorisations pour les applications GitHub

Vue d’ensemble

Utilisation de l’API

Écrire des scripts avec JavaScript

Découvrir les ressources pour un utilisateur

Livraison de déploiements

Rendu des données sous forme de graphes

Utilisation des commentaires

Pagination

Création d’un serveur CI

Bonnes pratiques

Bien démarrer - Base de données Git

Bien démarrer - Vérifications

Chiffrer des secrets

Guides

Artifacts

Autorisations

Secrets

Groupes d’exécuteurs auto-hébergés

Exécuteurs auto-hébergés

Travaux de workflow

Workflow runs

Workflows

Événements

Flux

Notifications

Attribution d’étoiles

Visionnage

Activité

Applications GitHub

Installations

Autorisations OAuth

Webhooks

Applications

Branches

Branches protégées

Exécutions de vérifications

Suites de vérifications

Vérifications

Analyse du code

Codes of conduct

Collaborateurs

Invitations

Commentaires de commit

États de validation

Clés de déploiement

Stratégies de branche de déploiement

Déploiements

Environnements

États des déploiements

Emojis

Statistiques d’administration

Annonce

Journal d’audit

Webhooks globaux

Licence

Organisations

Environnements de pré-réception

Utilisateurs

Administration d’entreprise

Gists

Commentaires

Objets blob

Références

Étiquettes

Arborescences

Base de données Git

Gitignore

Problèmes

Personnes responsables

Étapes majeures

Durée

Licences

Markdown

Statistiques

Mesures

Migrations

Membres

Collaborateurs externes

Pages

Boards

Cartes

Colonnes

Project boards

Tirages

Commentaires d’évaluation

Passer en revue les demandes

Révisions

Limite du taux

Réactions

Publications

Ressources de mise en production

Liens automatiques

Contenu

Fourches

Git LFS

Référentiels

Rechercher

Analyse de secrets

Teams

Commentaires de discussion

Discussions

Groupes externes

Abonnés

Clés GPG

Clés SSH Git

Configuration du webhook d’un dépôt

Livraisons de webhooks d’un dépôt

Webhooks de dépôt

API REST

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>