Add Protection to Branch struct #3095
Merged
Conversation
This file contains 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
Details regarding branch protection are provided APIs which return the "Branch With Protection" schema, such as '[Get a branch](https://docs.github.com/en/rest/branches/branches?apiVersion=2022-11-28#get-a-branch)'. This allows for getting branch protection information without needing to explicitly call the "Get branch protection" API. As the latter requires `administration:read` permissions while the former only requires `contents:read`, this enables users view branch protection information without requiring elevated permissions. The '[List branches](https://docs.github.com/en/rest/branches/branches?apiVersion=2022-11-28#list-branches)' API returns the `Short Branch` schema, which does not include `protection`, but since `protected` will still be `true`, a user could subsequently call 'Get a branch' to get further details.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3095 +/- ##
==========================================
- Coverage 97.72% 92.87% -4.86%
==========================================
Files 153 170 +17
Lines 13390 11403 -1987
==========================================
- Hits 13085 10590 -2495
- Misses 215 723 +508
Partials 90 90 ☔ View full report in Codecov by Sentry. |
gmlewis
approved these changes
Mar 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Details regarding branch protection are provided APIs which return the "Branch With Protection" schema, such as
'Get a branch'. This allows for getting branch protection information without needing to explicitly call the "Get branch protection" API. As the latter requires
administration:readpermissions while the former only requirescontents:read, this enables users view branch protection information without requiring elevated permissions.The 'List branches' API returns the
Short Branchschema, which does not includeprotection, but sinceprotectedwill still betrue, a user could subsequently call 'Get a branch' to get further details.