feat: Add required field on combined status responses - #4586
Open
jasonmcintosh wants to merge 2 commits into
Open
jasonmcintosh wants to merge 2 commits into
jasonmcintosh wants to merge 2 commits into
Conversation
…. This enables determining whether a checks on a PR are required without needing to check branch protection rules.
gmlewis
changed the title
Collaborator
|
Please run step 4 of CONTRIBUTING.md and push the changes to this PR. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This enables on status checks the ability to filter the list of status's to those that are REQUIRED to pass or not, allowing one to merge for example if all required checks pass, and others are not passed. The field is documented on github api's and ONLY on the CombinedStatus response types.
https://docs.github.com/en/rest/commits/statuses?apiVersion=2022-11-28#get-the-combined-status-for-a-specific-reference
With out this, you can't tell whether a status check is easily with the SDK without querying the required APIs which requires more administrative level access.