a340162d84
Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> Co-authored-by: Peter Bengtsson <peterbe@github.com>
64 lines
2.7 KiB
Markdown
64 lines
2.7 KiB
Markdown
---
|
|
title: Commits
|
|
intro: 'The commits API allows you to list, view, and compare commits in a repository. You can also interact with commit comments and commit statuses.'
|
|
allowTitleToDifferFromFilename: true
|
|
versions:
|
|
fpt: '*'
|
|
ghes: '*'
|
|
ghae: '*'
|
|
ghec: '*'
|
|
topics:
|
|
- API
|
|
miniTocMaxHeadingLevel: 3
|
|
---
|
|
|
|
{% for operation in currentRestOperations %}
|
|
{% unless operation.subcategory %}{% include rest_operation %}{% endunless %}
|
|
{% endfor %}
|
|
|
|
## Commit comments
|
|
|
|
### Custom media types for commit comments
|
|
|
|
These are the supported media types for commit comments. You can read more
|
|
about the use of media types in the API [here](/rest/overview/media-types).
|
|
|
|
application/vnd.github-commitcomment.raw+json
|
|
application/vnd.github-commitcomment.text+json
|
|
application/vnd.github-commitcomment.html+json
|
|
application/vnd.github-commitcomment.full+json
|
|
|
|
For more information, see "[Custom media types](/rest/overview/media-types)."
|
|
|
|
{% for operation in currentRestOperations %}
|
|
{% if operation.subcategory == 'comments' %}{% include rest_operation %}{% endif %}
|
|
{% endfor %}
|
|
|
|
## Commit statuses
|
|
|
|
The status API allows external services to mark commits with an `error`,
|
|
`failure`, `pending`, or `success` state, which is then reflected in pull requests
|
|
involving those commits.
|
|
|
|
Statuses can also include an optional `description` and `target_url`, and
|
|
we highly recommend providing them as they make statuses much more
|
|
useful in the GitHub UI.
|
|
|
|
As an example, one common use is for continuous integration
|
|
services to mark commits as passing or failing builds using status. The
|
|
`target_url` would be the full URL to the build output, and the
|
|
`description` would be the high level summary of what happened with the
|
|
build.
|
|
|
|
Statuses can include a `context` to indicate what service is providing that status.
|
|
For example, you may have your continuous integration service push statuses with a context of `ci`, and a security audit tool push statuses with a context of `security`. You can
|
|
then use the [Get the combined status for a specific reference](/rest/reference/commits#get-the-combined-status-for-a-specific-reference) to retrieve the whole status for a commit.
|
|
|
|
Note that the `repo:status` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted access to statuses **without** also granting access to repository code, while the
|
|
`repo` scope grants permission to code as well as statuses.
|
|
|
|
If you are developing a GitHub App and want to provide more detailed information about an external service, you may want to use the [Checks API](/rest/reference/checks).
|
|
|
|
{% for operation in currentRestOperations %}
|
|
{% if operation.subcategory == 'statuses' %}{% include rest_operation %}{% endif %}
|
|
{% endfor %} |