⚠️ refactor: rename fields on Branch Protection Pull Request rules

[diogoteles08]

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:

type RequiredPullRequestReviews struct {
	Required                     *bool // are PRs required
	RequiredApprovingReviewCount *int32
	DismissStaleReviews          *bool
	RequireCodeOwnerReviews      *bool
}

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 path RequiredPullRequestReviews.Required could get confusion, while PullRequestRule.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

• PR title follows the guidelines defined in our pull request documentation

This PR would probably be a breaking change because the changed struct is shared externally

[codecov]

Codecov Report

Merging #3879 (ec9fa04) into main (e780e08) will decrease coverage by 4.49%.
The diff coverage is 84.37%.

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     

[spencerschrock]

This would probably be a breaking (:warning:) change, given it's changing a struct in one of our main interfaces. With V5 on the horizon, it's something we can do. But would be good to properly categorize

[diogoteles08]

@spencerschrock Sorry, I forgot about this detail. I updated the PR title and the end of its description, PTAL

[github-actions]

This pull request is stale because it has been open for 10 days with no activity

[spencerschrock]

@spencerschrock Sorry, I forgot about this detail. I updated the PR title and the end of its description, PTAL

Now that #3759 is merged, this would need rebased (recreating + force pushing might just be easier). Overall, renaming SGTM.

[github-actions]

This pull request has been marked stale because it has been open for 10 days with no activity

[diogoteles08]

@spencerschrock rebased as requested =)

[spencerschrock]

/scdiff generate Branch-Protection

[github-actions]

Here's a link to the scdiff run