Skip to content

Commit

Permalink
Unify language in the API docs for commits (github#33369)
Browse files Browse the repository at this point in the history
  • Loading branch information
jhosman authored Dec 14, 2022
1 parent 7da39b4 commit eb8e941
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 11 deletions.
6 changes: 3 additions & 3 deletions content/rest/commits/comments.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Commit comments
intro: The Commit comments API lets you create and edit comments that relate to specific commits.
intro: Use the REST API to interact with commit comments.
versions:
fpt: '*'
ghes: '*'
Expand All @@ -12,9 +12,9 @@ miniTocMaxHeadingLevel: 3
allowTitleToDifferFromFilename: true
---

## About the commit comments API
## About commit comments

The Commit comments API lets you create and edit comments that relate to specific commits.
You can create, edit, and view commit comments using the REST API. A commit comment is a comment made on a specfic commit. For more information, see "[Working with comments](/rest/guides/working-with-comments#commit-comments)."

### Custom media types for commit comments

Expand Down
3 changes: 1 addition & 2 deletions content/rest/commits/commits.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
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.'
intro: 'Use the REST API to interact with commits.'
versions:
fpt: '*'
ghes: '*'
Expand All @@ -10,4 +10,3 @@ topics:
- API
miniTocMaxHeadingLevel: 3
---

2 changes: 1 addition & 1 deletion content/rest/commits/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
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.'
intro: 'Use the REST API to interact with commits.'
allowTitleToDifferFromFilename: true
versions:
fpt: '*'
Expand Down
10 changes: 5 additions & 5 deletions content/rest/commits/statuses.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Commit statuses
intro: 'The Commit status API allows external services to mark commits with a status, which is then reflected in pull requests involving those commits.'
intro: 'Use the REST API to interact with commit statuses.'
versions:
fpt: '*'
ghes: '*'
Expand All @@ -12,14 +12,14 @@ miniTocMaxHeadingLevel: 3
allowTitleToDifferFromFilename: true
---

## About the Commit statuses API
## About commit statuses

The Commit 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.
You can use the REST API to allow 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.
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 REST API to [Get the combined status for a specific reference](/rest/commits/statuses#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).
If you are developing a GitHub App and want to provide more detailed information about an external service, you may want to use the REST API to manage checks. For more information, see "[Checks](/rest/reference/checks)."

0 comments on commit eb8e941

Please sign in to comment.