feat: add flag --pr-merge-branch-protection

This flag lets you pick how to handle branch protection rules.

`statusChecks` waits until all **required** statues & check rules (from
Statues & Checks API, respectively) are in a "success" state.
For Checks this also means any rule that has a "neutral" or "skipped" conclusion.
It looks at both required statues configured under branch protection rules **and**
rulesets. This is the flag default to maintain backwards compatibility pre-`v1.6.1`.

`all` waits until **all** branch protection rules are met. This also includes any
matching Rules defined via the Rulesets API.

`bypass` lets you bypass all branch protection rules once the authenticated
user has the ability. That is, the user/app is configured to bypass rules.

Also bumped Github Client to v57 to be able to use the Ruleset API.

This should fix issue dailymotion-oss#293.

Author: jashandeep-sohi

docs/current-version/content/repos/pull-request.md

@@ -96,3 +96,7 @@ All the following flags only apply if `--pr-merge` is enabled.
 - `--pr-merge-poll-timeout` (string/duration): maximum duration to wait for a Pull Request to be mergeable/merged, using the [Golang syntax](https://golang.org/pkg/time/#ParseDuration). Default to `10m` (10 minutes).
 - `--pr-merge-poll-interval` (string/duration): duration to wait for between each GitHub API call to check if a PR is mergeable/merged, using the [Golang syntax](https://golang.org/pkg/time/#ParseDuration). Default to `30s` (30 seconds).
 - `--pr-merge-retry-count` (int): number of times to retry the merge operation in case of merge failure. Default to `3`.
+- `--pr-merge-branch-protection` (string): One of `statusChecks`, `all`, `bypass`. Wait for the specified kind of branch protection rules to be satisfied before attempting to merge.
+  - `statusChecks` waits only for status checks to be passing. This is the default.
+  - `all` waits for every rule (approvals, commit signature, etc).
+  - `bypass` will bypass branch protection rules when possible (i.e. the authenticated user/app have permissions to do so).

go.mod

@@ -8,7 +8,7 @@ require (
 	github.com/bradleyfalzon/ghinstallation v1.1.1
 	github.com/cosiner/argv v0.1.1-0.20200416041250-86e3c689263e
 	github.com/go-git/go-git/v5 v5.10.1
-	github.com/google/go-github/v36 v36.0.0
+	github.com/google/go-github/v57 v57.0.0
 	github.com/imdario/mergo v0.3.16
 	github.com/mattn/go-zglob v0.0.4
 	github.com/mholt/archiver v3.1.1+incompatible
@@ -22,6 +22,7 @@ require (
 	github.com/stretchr/testify v1.8.4
 	github.com/writeas/go-strip-markdown v2.0.1+incompatible
 	github.com/ybbus/httpretry v1.0.2
+	github.com/zoumo/goset v0.2.0
 	go.mozilla.org/sops/v3 v3.7.3
 	golang.org/x/oauth2 v0.15.0
 	gopkg.in/op/go-logging.v1 v1.0.0-20160211212156-b2cb9fa56473

go.sum

@@ -212,14 +212,13 @@ github.com/google/go-cmp v0.5.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/
 github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.3/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
-github.com/google/go-cmp v0.5.6/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
 github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/google/go-github/v29 v29.0.2/go.mod h1:CHKiKKPHJ0REzfwc14QMklvtHwCveD0PxlMjLlzAM5E=
 github.com/google/go-github/v29 v29.0.3 h1:IktKCTwU//aFHnpA+2SLIi7Oo9uhAzgsdZNbcAqhgdc=
 github.com/google/go-github/v29 v29.0.3/go.mod h1:CHKiKKPHJ0REzfwc14QMklvtHwCveD0PxlMjLlzAM5E=
-github.com/google/go-github/v36 v36.0.0 h1:ndCzM616/oijwufI7nBRa+5eZHLldT+4yIB68ib5ogs=
-github.com/google/go-github/v36 v36.0.0/go.mod h1:LFlKC047IOqiglRGNqNb9s/iAPTnnjtlshm+bxp+kwk=
+github.com/google/go-github/v57 v57.0.0 h1:L+Y3UPTY8ALM8x+TV0lg+IEBI+upibemtBD8Q9u7zHs=
+github.com/google/go-github/v57 v57.0.0/go.mod h1:s0omdnye0hvK/ecLvpsGfJMiRt85PimQh4oygmLIxHw=
 github.com/google/go-querystring v1.0.0/go.mod h1:odCYkC5MyYFN7vkCjXpyrEuKhc/BUO6wN/zVPAxq5ck=
 github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8=
 github.com/google/go-querystring v1.1.0/go.mod h1:Kcdr2DB4koayq7X8pmAG4sNG59So17icRSOU623lUBU=
@@ -487,6 +486,8 @@ github.com/xi2/xz v0.0.0-20171230120015-48954b6210f8/go.mod h1:HUYIGzjTL3rfEspMx
 github.com/ybbus/httpretry v1.0.2 h1:QIU8dfSF+kZx5xO1bUcLKyxYNEUsLX/hsN6gN6Up1So=
 github.com/ybbus/httpretry v1.0.2/go.mod h1:fwOEa1URVFYikEqgQLCBtLyExFt5danZrxF5xF2qZh8=
 github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
+github.com/zoumo/goset v0.2.0 h1:mflvfwZfKiayxR8/7fFBhvWHzhXU+aVP2nOzTEKVTfU=
+github.com/zoumo/goset v0.2.0/go.mod h1:9N4gYaiVAbD/SytgmvFUlacbp1lSItmws1xNdzVslH4=
 go.mozilla.org/gopgagent v0.0.0-20170926210634-4d7ea76ff71a h1:N7VD+PwpJME2ZfQT8+ejxwA4Ow10IkGbU0MGf94ll8k=
 go.mozilla.org/gopgagent v0.0.0-20170926210634-4d7ea76ff71a/go.mod h1:YDKUvO0b//78PaaEro6CAPH6NqohCmL2Cwju5XI2HoE=
 go.mozilla.org/sops/v3 v3.7.3 h1:CYx02LnWTATWv6NqWJIt4JCKVKSnGV+MsRiDpvwWQhg=

main.go

@@ -37,6 +37,9 @@ var options struct {
 }
 
 func init() {
+	// defaults
+	options.GitHub.PullRequest.Merge.BranchProtection = repository.BranchProtectionKindStatusChecks
+
 	// required flags
 	pflag.StringArrayVarP(&options.updates, "update", "u", nil, `An update operation, such as "yaml(file=config.yaml,path='version')=file(path=VERSION)" - see the online documentation for all available updaters.`)
 	assert(pflag.CommandLine.SetAnnotation("update", "mandatory", []string{"true"}))
@@ -73,6 +76,7 @@ func init() {
 	pflag.DurationVar(&options.GitHub.PullRequest.Merge.PollTimeout, "pr-merge-poll-timeout", 10*time.Minute, "If pr-merge is enabled, this is the maximum duration to wait for a Pull Request to be mergeable/merged.")
 	pflag.DurationVar(&options.GitHub.PullRequest.Merge.PollInterval, "pr-merge-poll-interval", 30*time.Second, "If pr-merge is enabled, this is the duration to wait for between each GitHub API call to check if a PR is mergeable/merged.")
 	pflag.IntVar(&options.GitHub.PullRequest.Merge.RetryCount, "pr-merge-retry-count", 3, "If pr-merge is enabled, this is the number of times to retry the merge operation in case of merge failure.")
+	pflag.Var(&options.GitHub.PullRequest.Merge.BranchProtection, "pr-merge-branch-protection", `If pr-merge is enabled, then wait for the specified kind of branch protection rules to be satisfied before attempting to merge. "statusChecks" waits only for status checks to be passing. "all" waits for every rule (approvals, commit signature, etc). "bypass" will bypass branch protection rules when possible.`)
 
 	// git-related flags
 	pflag.StringVar(&options.UpdateOptions.Git.CloneDir, "git-clone-dir", temporaryDirectory(), "Directory used to clone the repositories.")

repository/discover_from_query.go

@@ -4,7 +4,7 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/google/go-github/v36/github"
+	"github.com/google/go-github/v57/github"
 )
 
 func discoverRepositoriesFromQuery(ctx context.Context, searchType SearchType, query string, params map[string]string, githubOpts GitHubOptions) ([]Repository, error) {

repository/github_client.go

@@ -7,7 +7,7 @@ import (
 	"net/url"
 
 	"github.com/bradleyfalzon/ghinstallation"
-	"github.com/google/go-github/v36/github"
+	"github.com/google/go-github/v57/github"
 	"github.com/shurcooL/githubv4"
 	"github.com/sirupsen/logrus"
 	"github.com/ybbus/httpretry"
@@ -57,9 +57,22 @@ func githubClient(ctx context.Context, ghOptions GitHubOptions) (*github.Client,
 	return ghc, token, nil
 }
 
+type graphqlTransport struct {
+	base http.RoundTripper
+}
+
+func (t *graphqlTransport) RoundTrip(req *http.Request) (*http.Response, error) {
+	// Enable PullRequest.mergeStateStatus
+	req.Header.Add("accept", "application/vnd.github.merge-info-preview+json")
+
+	return t.base.RoundTrip(req)
+}
+
 func githubGraphqlClient(ctx context.Context, ghOptions GitHubOptions) (*githubv4.Client, error) {
 	httpClient, _, err := githubAuthenticatedHTTPClient(ctx, ghOptions)
 
+	httpClient.Transport = &graphqlTransport{base: httpClient.Transport}
+
 	if err != nil {
 		return nil, err
 	}

repository/options.go

@@ -1,6 +1,7 @@
 package repository
 
 import (
+	"errors"
 	"fmt"
 	"strings"
 	"time"
@@ -74,18 +75,58 @@ type PullRequestOptions struct {
 	Merge                PullRequestMergeOptions
 }
 
+// BranchProtectionKind enumerates possible branch protections to wait for before attempting a PR merge.
+type BranchProtectionKind string
+
+const (
+	// BranchProtectionKindStatusChecks waits for all required statues & checksuite runs to be passing ("success", "neutral", "skipped")
+	BranchProtectionKindStatusChecks BranchProtectionKind = "statusChecks"
+
+	// BranchProtectionKindAll wait for all protection rules
+	BranchProtectionKindAll BranchProtectionKind = "all"
+
+	// BranchProtectionKindBypass waits until the user can bypass branch protection rules
+	BranchProtectionKindBypass BranchProtectionKind = "bypass"
+)
+
+func (b *BranchProtectionKind) String() string {
+	return string(*b)
+}
+
+func (b *BranchProtectionKind) Set(s string) error {
+	switch s {
+	case string(BranchProtectionKindStatusChecks), string(BranchProtectionKindAll), string(BranchProtectionKindBypass):
+		*b = BranchProtectionKind(s)
+		return nil
+	default:
+		return errors.New("invalid value")
+	}
+}
+
+func (b *BranchProtectionKind) Type() string {
+	return strings.Join(
+		[]string{
+			string(BranchProtectionKindStatusChecks),
+			string(BranchProtectionKindAll),
+			string(BranchProtectionKindBypass),
+		},
+		"|",
+	)
+}
+
 // PullRequestMergeOptions holds all the options required to merge github PRs
 type PullRequestMergeOptions struct {
-	Enabled       bool
-	Auto          bool
-	AutoWait      bool
-	Method        string
-	CommitTitle   string
-	CommitMessage string
-	SHA           string
-	PollInterval  time.Duration
-	PollTimeout   time.Duration
-	RetryCount    int
+	Enabled          bool
+	Auto             bool
+	AutoWait         bool
+	Method           string
+	CommitTitle      string
+	CommitMessage    string
+	SHA              string
+	PollInterval     time.Duration
+	PollTimeout      time.Duration
+	RetryCount       int
+	BranchProtection BranchProtectionKind
 }
 
 func (o *GitOptions) setDefaultValues(updaters []update.Updater, tplExecutorFunc templateExecutor) error {