Skip to content

Update Commits API reference in protected branches docs #21609

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

Merged
merged 3 commits into from
Oct 25, 2022
Merged

Update Commits API reference in protected branches docs #21609

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
94b558b
Update Commits API reference in protected branches docs
fstavela Oct 25, 2022
bd48d0e
Update content/repositories/configuring-branches-and-merges-in-your-r…
jhosman Oct 25, 2022
1aff629
Merge branch 'main' into commit-statuses-ref
jhosman Oct 25, 2022
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 ...pository/defining-the-mergeability-of-pull-requests/about-protected-branches.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Optionally, you can require approvals from someone other than the last person to

Required status checks ensure that all required CI tests are passing before collaborators can make changes to a protected branch. Required status checks can be checks or statuses. For more information, see "[About status checks](/github/collaborating-with-issues-and-pull-requests/about-status-checks)."

Before you can enable required status checks, you must configure the repository to use the status API. For more information, see "[Repositories](/rest/reference/commits#commit-statuses)" in the REST documentation.
Before you can enable required status checks, you must configure the repository to use the status API. For more information, see "[Commits](/rest/commits/statuses)" in the REST documentation.

After enabling required status checks, all required status checks must pass before collaborators can merge changes into the protected branch. After all required status checks pass, any commits must either be pushed to another branch and then merged or pushed directly to the protected branch.

Expand Down