Skip to content

docs(rest): note when commit comments may be disabled #45000

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
happysnaker wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −1
Open

docs(rest): note when commit comments may be disabled #45000

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/rest/commits/comments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ category:

## About commit comments

You can create, edit, and view commit comments using the REST API. A commit comment is a comment made on a specific commit. For more information, see [AUTOTITLE](/rest/guides/working-with-comments#commit-comments).
You can create, edit, and view commit comments using the REST API. A commit comment is a comment made on a specific commit. {% ifversion fpt or ghec or ghes > 3.21 %}For repositories that belong to organizations, commit comments can be disabled at the organization or repository level. If commit comments are disabled, people cannot create new commit comments, and requests to create a commit comment may return `403 Forbidden`. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/managing-commit-comments-for-your-organization). {% endif %}For more information, see [AUTOTITLE](/rest/guides/working-with-comments#commit-comments).

<!-- Content after this section is automatically generated -->
4 changes: 4 additions & 0 deletions content/rest/guides/working-with-comments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,10 @@ deal specifically with the way a particular change was implemented within a file
The last type of comments occur specifically on individual commits. For this reason,
they make use of [the endpoint to manage commit comments](/rest/commits#get-a-commit-comment).

{% ifversion fpt or ghec or ghes > 3.21 %}
For repositories that belong to organizations, commit comments can be disabled at the organization or repository level. If commit comments are disabled, people cannot create new commit comments, and requests to create a commit comment may return `403 Forbidden`. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/managing-commit-comments-for-your-organization).
{% endif %}

To retrieve the comments on a commit, you'll want to use the SHA1 of the commit.
In other words, you won't use any identifier related to the Pull Request. Here's an example:

Expand Down
Loading