-
Notifications
You must be signed in to change notification settings - Fork 474
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.
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
⚠️ refactor: rename fields on Branch Protection Pull Request rules #3879
⚠️ refactor: rename fields on Branch Protection Pull Request rules #3879
Conversation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #3879 +/- ##
==========================================
- Coverage 75.01% 70.52% -4.49%
==========================================
Files 227 227
Lines 16263 16263
==========================================
- Hits 12199 11469 -730
- Misses 3290 4067 +777
+ Partials 774 727 -47 |
0da2c42
to
490c30b
Compare
490c30b
to
53ed51d
Compare
This would probably be a breaking ( |
@spencerschrock Sorry, I forgot about this detail. I updated the PR title and the end of its description, PTAL |
This pull request is stale because it has been open for 10 days with no activity |
Now that #3759 is merged, this would need rebased (recreating + force pushing might just be easier). Overall, renaming SGTM. |
This pull request has been marked stale because it has been open for 10 days with no activity |
Signed-off-by: Diogo Teles Sant'Anna <diogoteles@google.com>
6c957f5
to
fd0231b
Compare
@spencerschrock rebased as requested =) |
/scdiff generate Branch-Protection |
Signed-off-by: Diogo Teles Sant'Anna <diogoteles@google.com>
This change was briefly discussed at #3728 (comment)
This PR solely renames part of the structure that represents Branch Protection rules.
Inside the structure clients.BranchRef.BranchProtectionRule, I'm renaming RequiredPullRequestReviews to PullRequestRule.
The previous struct declaration is the following:
The reason is that the field doesn't refer only to Required reviews of pull requests, it refers to different Branch protection rules around Pull Requests. More specifically, it has the field
Required
, that states if PRs are either required or not to make changes to that branch. The pathRequiredPullRequestReviews.Required
could get confusion, whilePullRequestRule.Required
is clearer. Additionally, all the other fields inside that struct already have the word "Review" on it, so it's redundant to have it also on the struct name.What kind of change does this PR introduce?
Refactor
This PR would probably be a breaking change because the changed struct is shared externally