docs icon indicating copy to clipboard operation
docs copied to clipboard

permission needed for creating commit comment is wrong

Open kj-9 opened this issue 1 year ago • 2 comments
trafficstars

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/rest/commits/comments?apiVersion=2022-11-28#create-a-commit-comment

specifically, https://arc.net/l/quote/xyiivuna

What part(s) of the article would you like to see updated?

currently:

The fine-grained token must have the following permission set:
- "Contents" repository permissions (read)

but I think correctly:

The fine-grained token must have the following permission set:
- "Contents" repository permissions (**write**)

it requires write permmison.

Additional information

because in my repo, i need content: write to create commit comment.

before that, create commit comment failed in gha, with content: read (although it exits 0)

kj-9 avatar Oct 20 '24 14:10 kj-9

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar Oct 20 '24 14:10 welcome[bot]

@kj-9 Thank you for raising this issue! I'll get this triaged for review :sparkles: Our team will provide feedback regarding the best next steps for this issue - thanks for your patience! 💛

nguyenalex836 avatar Oct 21 '24 17:10 nguyenalex836

Many thanks for including such clear details of the bug you found in the docs 💖

Since the REST API docs are automatically generated from the OpenAPI schema, which is maintained internally, we'll have to fix this with an internal pull request.

felicitymay avatar Oct 23 '24 11:10 felicitymay

Thank you for opening this issue! Updates to this documentation must be made internally. I have copied your issue to an internal issue, so I will close this issue.

docs-bot avatar Oct 23 '24 11:10 docs-bot