|
| 1 | +--- |
| 2 | +name: Compare two commits |
| 3 | +example: octokit.rest.repos.compareCommitsWithBasehead({ owner, repo, basehead }) |
| 4 | +route: GET /repos/{owner}/{repo}/compare/{basehead} |
| 5 | +scope: repos |
| 6 | +type: API method |
| 7 | +--- |
| 8 | + |
| 9 | +# Compare two commits |
| 10 | + |
| 11 | +The `basehead` param is comprised of two parts: `base` and `head`. Both must be branch names in `repo`. To compare branches across other repositories in the same network as `repo`, use the format `<USERNAME>:branch`. |
| 12 | + |
| 13 | +The response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. |
| 14 | + |
| 15 | +The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. |
| 16 | + |
| 17 | +**Working with large comparisons** |
| 18 | + |
| 19 | +To process a response with a large number of commits, you can use (`per_page` or `page`) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see "[Traversing with pagination](/rest/guides/traversing-with-pagination)." |
| 20 | + |
| 21 | +When calling this API without any paging parameters (`per_page` or `page`), the returned list is limited to 250 commits and the last commit in the list is the most recent of the entire comparison. When a paging parameter is specified, the first commit in the returned list of each page is the earliest. |
| 22 | + |
| 23 | +**Signature verification object** |
| 24 | + |
| 25 | +The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: |
| 26 | + |
| 27 | +| Name | Type | Description | |
| 28 | +| ----------- | --------- | ------------------------------------------------------------------------------------------------ | |
| 29 | +| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | |
| 30 | +| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | |
| 31 | +| `signature` | `string` | The signature that was extracted from the commit. | |
| 32 | +| `payload` | `string` | The value that was signed. | |
| 33 | + |
| 34 | +These are the possible values for `reason` in the `verification` object: |
| 35 | + |
| 36 | +| Value | Description | |
| 37 | +| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- | |
| 38 | +| `expired_key` | The key that made the signature is expired. | |
| 39 | +| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | |
| 40 | +| `gpgverify_error` | There was an error communicating with the signature verification service. | |
| 41 | +| `gpgverify_unavailable` | The signature verification service is currently unavailable. | |
| 42 | +| `unsigned` | The object does not include a signature. | |
| 43 | +| `unknown_signature_type` | A non-PGP signature was found in the commit. | |
| 44 | +| `no_user` | No user was associated with the `committer` email address in the commit. | |
| 45 | +| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | |
| 46 | +| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | |
| 47 | +| `unknown_key` | The key that made the signature has not been registered with any user's account. | |
| 48 | +| `malformed_signature` | There was an error parsing the signature. | |
| 49 | +| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | |
| 50 | +| `valid` | None of the above errors applied, so the signature is considered to be verified. | |
| 51 | + |
| 52 | +```js |
| 53 | +octokit.rest.repos.compareCommitsWithBasehead({ |
| 54 | + owner, |
| 55 | + repo, |
| 56 | + basehead, |
| 57 | +}); |
| 58 | +``` |
| 59 | + |
| 60 | +## Parameters |
| 61 | + |
| 62 | +<table> |
| 63 | + <thead> |
| 64 | + <tr> |
| 65 | + <th>name</th> |
| 66 | + <th>required</th> |
| 67 | + <th>description</th> |
| 68 | + </tr> |
| 69 | + </thead> |
| 70 | + <tbody> |
| 71 | + <tr><td>owner</td><td>yes</td><td> |
| 72 | + |
| 73 | +</td></tr> |
| 74 | +<tr><td>repo</td><td>yes</td><td> |
| 75 | + |
| 76 | +</td></tr> |
| 77 | +<tr><td>page</td><td>no</td><td> |
| 78 | + |
| 79 | +Page number of the results to fetch. |
| 80 | + |
| 81 | +</td></tr> |
| 82 | +<tr><td>per_page</td><td>no</td><td> |
| 83 | + |
| 84 | +Results per page (max 100) |
| 85 | + |
| 86 | +</td></tr> |
| 87 | +<tr><td>basehead</td><td>yes</td><td> |
| 88 | + |
| 89 | +The base branch and head branch to compare. This parameter expects the format `{base}...{head}`. |
| 90 | + |
| 91 | +</td></tr> |
| 92 | + </tbody> |
| 93 | +</table> |
| 94 | + |
| 95 | +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#compare-two-commits). |
0 commit comments