Make required atlantis/apply status check work with mergeable using --gh-allow-mergeable-bypass-apply

cmd/server.go

@@ -37,55 +37,56 @@ import (
 // 3. Add your flag's description etc. to the stringFlags, intFlags, or boolFlags slices.
 const (
 	// Flag names.
-	ADWebhookPasswordFlag      = "azuredevops-webhook-password" // nolint: gosec
-	ADWebhookUserFlag          = "azuredevops-webhook-user"
-	ADTokenFlag                = "azuredevops-token" // nolint: gosec
-	ADUserFlag                 = "azuredevops-user"
-	ADHostnameFlag             = "azuredevops-hostname"
-	AllowForkPRsFlag           = "allow-fork-prs"
-	AllowRepoConfigFlag        = "allow-repo-config"
-	AtlantisURLFlag            = "atlantis-url"
-	AutomergeFlag              = "automerge"
-	AutoplanFileListFlag       = "autoplan-file-list"
-	BitbucketBaseURLFlag       = "bitbucket-base-url"
-	BitbucketTokenFlag         = "bitbucket-token"
-	BitbucketUserFlag          = "bitbucket-user"
-	BitbucketWebhookSecretFlag = "bitbucket-webhook-secret"
-	ConfigFlag                 = "config"
-	CheckoutStrategyFlag       = "checkout-strategy"
-	DataDirFlag                = "data-dir"
-	DefaultTFVersionFlag       = "default-tf-version"
-	DisableApplyAllFlag        = "disable-apply-all"
-	DisableApplyFlag           = "disable-apply"
-	DisableAutoplanFlag        = "disable-autoplan"
-	DisableMarkdownFoldingFlag = "disable-markdown-folding"
-	DisableRepoLockingFlag     = "disable-repo-locking"
-	EnablePolicyChecksFlag     = "enable-policy-checks"
-	EnableRegExpCmdFlag        = "enable-regexp-cmd"
-	EnableDiffMarkdownFormat   = "enable-diff-markdown-format"
-	GHHostnameFlag             = "gh-hostname"
-	GHTeamAllowlistFlag        = "gh-team-allowlist"
-	GHTokenFlag                = "gh-token"
-	GHUserFlag                 = "gh-user"
-	GHAppIDFlag                = "gh-app-id"
-	GHAppKeyFlag               = "gh-app-key"
-	GHAppKeyFileFlag           = "gh-app-key-file"
-	GHAppSlugFlag              = "gh-app-slug"
-	GHOrganizationFlag         = "gh-org"
-	GHWebhookSecretFlag        = "gh-webhook-secret" // nolint: gosec
-	GitlabHostnameFlag         = "gitlab-hostname"
-	GitlabTokenFlag            = "gitlab-token"
-	GitlabUserFlag             = "gitlab-user"
-	GitlabWebhookSecretFlag    = "gitlab-webhook-secret" // nolint: gosec
-	APISecretFlag              = "api-secret"
-	HidePrevPlanComments       = "hide-prev-plan-comments"
-	LogLevelFlag               = "log-level"
-	ParallelPoolSize           = "parallel-pool-size"
-	StatsNamespace             = "stats-namespace"
-	AllowDraftPRs              = "allow-draft-prs"
-	PortFlag                   = "port"
-	RepoConfigFlag             = "repo-config"
-	RepoConfigJSONFlag         = "repo-config-json"
+	ADWebhookPasswordFlag       = "azuredevops-webhook-password" // nolint: gosec
+	ADWebhookUserFlag           = "azuredevops-webhook-user"
+	ADTokenFlag                 = "azuredevops-token" // nolint: gosec
+	ADUserFlag                  = "azuredevops-user"
+	ADHostnameFlag              = "azuredevops-hostname"
+	AllowForkPRsFlag            = "allow-fork-prs"
+	AllowRepoConfigFlag         = "allow-repo-config"
+	AtlantisURLFlag             = "atlantis-url"
+	AutomergeFlag               = "automerge"
+	AutoplanFileListFlag        = "autoplan-file-list"
+	BitbucketBaseURLFlag        = "bitbucket-base-url"
+	BitbucketTokenFlag          = "bitbucket-token"
+	BitbucketUserFlag           = "bitbucket-user"
+	BitbucketWebhookSecretFlag  = "bitbucket-webhook-secret"
+	ConfigFlag                  = "config"
+	CheckoutStrategyFlag        = "checkout-strategy"
+	DataDirFlag                 = "data-dir"
+	DefaultTFVersionFlag        = "default-tf-version"
+	DisableApplyAllFlag         = "disable-apply-all"
+	DisableApplyFlag            = "disable-apply"
+	DisableAutoplanFlag         = "disable-autoplan"
+	DisableMarkdownFoldingFlag  = "disable-markdown-folding"
+	DisableRepoLockingFlag      = "disable-repo-locking"
+	EnablePolicyChecksFlag      = "enable-policy-checks"
+	EnableRegExpCmdFlag         = "enable-regexp-cmd"
+	EnableDiffMarkdownFormat    = "enable-diff-markdown-format"
+	GHHostnameFlag              = "gh-hostname"
+	GHTeamAllowlistFlag         = "gh-team-allowlist"
+	GHTokenFlag                 = "gh-token"
+	GHUserFlag                  = "gh-user"
+	GHAppIDFlag                 = "gh-app-id"
+	GHAppKeyFlag                = "gh-app-key"
+	GHAppKeyFileFlag            = "gh-app-key-file"
+	GHAppSlugFlag               = "gh-app-slug"
+	GHOrganizationFlag          = "gh-org"
+	GHWebhookSecretFlag         = "gh-webhook-secret"               // nolint: gosec
+	GHAllowMergeableBypassApply = "gh-allow-mergeable-bypass-apply" // nolint: gosec
+	GitlabHostnameFlag          = "gitlab-hostname"
+	GitlabTokenFlag             = "gitlab-token"
+	GitlabUserFlag              = "gitlab-user"
+	GitlabWebhookSecretFlag     = "gitlab-webhook-secret" // nolint: gosec
+	APISecretFlag               = "api-secret"
+	HidePrevPlanComments        = "hide-prev-plan-comments"
+	LogLevelFlag                = "log-level"
+	ParallelPoolSize            = "parallel-pool-size"
+	StatsNamespace              = "stats-namespace"
+	AllowDraftPRs               = "allow-draft-prs"
+	PortFlag                    = "port"
+	RepoConfigFlag              = "repo-config"
+	RepoConfigJSONFlag          = "repo-config-json"
 	// RepoWhitelistFlag is deprecated for RepoAllowlistFlag.
 	RepoWhitelistFlag          = "repo-whitelist"
 	RepoAllowlistFlag          = "repo-allowlist"
@@ -374,6 +375,10 @@ var boolFlags = map[string]boolFlag{
 		description:  "Enable Atlantis to format Terraform plan output into a markdown-diff friendly format for color-coding purposes.",
 		defaultValue: false,
 	},
+	GHAllowMergeableBypassApply: {
+		description:  "Feature flag to enable functionality to allow mergeable check to ignore apply required check",
+		defaultValue: false,
+	},
 	AllowDraftPRs: {
 		description:  "Enable autoplan for Github Draft Pull Requests",
 		defaultValue: false,

runatlantis.io/docs/server-configuration.md

@@ -369,6 +369,12 @@ Values are chosen in this order:
   ```
   Comma-separated list of GitHub team name (not a slug) and permission pairs. By default, any team can plan and apply.
 
+- ### `--gh-allow-mergeable-bypass-apply`
+  ```bash
+  atlantis server --gh-allow-mergeable-bypass-apply
+  ```
+  Feature flag to enable ability to use `mergeable` mode with required apply status check.
+
 ### `--gitlab-hostname`
   ```bash
   atlantis server --gitlab-hostname="my.gitlab.enterprise.com"

server/controllers/github_app_controller.go

@@ -55,7 +55,8 @@ func (g *GithubAppController) ExchangeCode(w http.ResponseWriter, r *http.Reques
 
 	g.Logger.Debug("Exchanging GitHub app code for app credentials")
 	creds := &vcs.GithubAnonymousCredentials{}
-	client, err := vcs.NewGithubClient(g.GithubHostname, creds, g.Logger)
+	config := vcs.GithubConfig{}
+	client, err := vcs.NewGithubClient(g.GithubHostname, creds, config, g.Logger)
 	if err != nil {
 		g.respond(w, logging.Error, http.StatusInternalServerError, "Failed to exchange code for github app: %s", err)
 		return

server/events/vcs/fixtures/github-commit-status-full.json

@@ -0,0 +1,148 @@
+{
+    "state": "blocked",
+    "statuses": [
+      {
+        "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+        "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
+        "id": 16230299674,
+        "node_id": "SC_kwDOFRFvL88AAAADx2a4Gg",
+        "state": "success",
+        "description": "Plan succeeded.",
+        "target_url": "https://localhost/jobs/octocat/Hello-World/1/project1",
+        "context": "atlantis/plan: project1",
+        "created_at": "2022-02-10T15:26:01Z",
+        "updated_at": "2022-02-10T15:26:01Z"
+      },
+      {
+        "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+        "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
+        "id": 16230303174,
+        "node_id": "SC_kwDOFRFvL88AAAADx2bFxg",
+        "state": "success",
+        "description": "Plan succeeded.",
+        "target_url": "https://localhost/jobs/octocat/Hello-World/1/project2",
+        "context": "atlantis/plan: project2",
+        "created_at": "2022-02-10T15:26:12Z",
+        "updated_at": "2022-02-10T15:26:12Z"
+      },
+      {
+        "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+        "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
+        "id": 16230303679,
+        "node_id": "SC_kwDOFRFvL88AAAADx2bHvw",
+        "state": "success",
+        "description": "2/2 projects planned successfully.",
+        "target_url": "",
+        "context": "atlantis/plan",
+        "created_at": "2022-02-10T15:26:13Z",
+        "updated_at": "2022-02-10T15:26:13Z"
+      },
+      {
+        "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+        "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
+        "id": 16230307923,
+        "node_id": "SC_kwDOFRFvL88AAAADx2bYUw",
+        "state": "failure",
+        "description": "Apply failed.",
+        "target_url": "https://localhost/jobs/octocat/Hello-World/1/project1",
+        "context": "atlantis/apply: project1",
+        "created_at": "2022-02-10T15:26:27Z",
+        "updated_at": "2022-02-10T15:26:27Z"
+      },
+      {
+        "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+        "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
+        "id": 16230308153,
+        "node_id": "SC_kwDOFRFvL88AAAADx2bZOQ",
+        "state": "failure",
+        "description": "Apply failed.",
+        "target_url": "https://localhost/jobs/octocat/Hello-World/1/project2",
+        "context": "atlantis/apply: project2",
+        "created_at": "2022-02-10T15:26:27Z",
+        "updated_at": "2022-02-10T15:26:27Z"
+      },
+      {
+        "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+        "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
+        "id": 16230308528,
+        "node_id": "SC_kwDOFRFvL88AAAADx2basA",
+        "state": "failure",
+        "description": "0/2 projects applied successfully.",
+        "target_url": "",
+        "context": "atlantis/apply",
+        "created_at": "2022-02-10T15:26:28Z",
+        "updated_at": "2022-02-10T15:26:28Z"
+      }
+    ],
+    "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+    "total_count": 0,
+    "repository": {
+      "id": 1296269,
+      "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+      "name": "Hello-World",
+      "full_name": "octocat/Hello-World",
+      "private": false,
+      "owner": {
+        "login": "octocat",
+        "id": 583231,
+        "node_id": "MDQ6VXNlcjU4MzIzMQ==",
+        "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
+        "gravatar_id": "",
+        "url": "https://api.github.com/users/octocat",
+        "html_url": "https://github.com/octocat",
+        "followers_url": "https://api.github.com/users/octocat/followers",
+        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+        "organizations_url": "https://api.github.com/users/octocat/orgs",
+        "repos_url": "https://api.github.com/users/octocat/repos",
+        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+        "received_events_url": "https://api.github.com/users/octocat/received_events",
+        "type": "User",
+        "site_admin": false
+      },
+      "html_url": "https://github.com/octocat/Hello-World",
+      "description": "My first repository on GitHub!",
+      "fork": false,
+      "url": "https://api.github.com/repos/octocat/Hello-World",
+      "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+      "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+      "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+      "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+      "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+      "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+      "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+      "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+      "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+      "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+      "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+      "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+      "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+      "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+      "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+      "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+      "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+      "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+      "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+      "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+      "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+      "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+      "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+      "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+      "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+      "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+      "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+      "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+      "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+      "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+      "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+      "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+      "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+      "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+      "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+      "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments"
+    },
+    "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+    "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/status"
+  }