add ignore_default_branch_pull_requests to provider settings (#918)

* WIP: add ignore_default_branch_pull_requests setting to provider settings

* update docs

* retrieve state from API

* chore(tests): add a test for ignore_default_branch field setting

Signed-off-by: Ben McNicholl <[email protected]>

---------

Signed-off-by: Ben McNicholl <[email protected]>
Co-authored-by: Ben McNicholl <[email protected]>

Author: patrobinson

buildkite/resource_pipeline.go

@@ -117,6 +117,7 @@ type providerSettingsModel struct {
 	PublishBlockedAsPending                 types.Bool   `tfsdk:"publish_blocked_as_pending"`
 	PublishCommitStatusPerStep              types.Bool   `tfsdk:"publish_commit_status_per_step"`
 	SeparatePullRequestStatuses             types.Bool   `tfsdk:"separate_pull_request_statuses"`
+	IgnoreDefaultBranchPullRequests         types.Bool   `tfsdk:"ignore_default_branch_pull_requests"`
 }
 
 type pipelineResource struct {
@@ -725,6 +726,11 @@ func (*pipelineResource) Schema(ctx context.Context, req resource.SchemaRequest,
 						MarkdownDescription: "Whether to create a separate status for pull request builds, allowing you to require a passing pull request" +
 							" build in your [required status checks](https://help.github.com/en/articles/enabling-required-status-checks) in GitHub.",
 					},
+					"ignore_default_branch_pull_requests": schema.BoolAttribute{
+						Computed:            true,
+						Optional:            true,
+						MarkdownDescription: "Whether to prevent caching pull requests with the source branch matching the default branch.",
+					},
 				},
 			},
 		},
@@ -1056,6 +1062,7 @@ type PipelineExtraSettings struct {
 	PublishBlockedAsPending                 *bool   `json:"publish_blocked_as_pending,omitempty"`
 	PublishCommitStatusPerStep              *bool   `json:"publish_commit_status_per_step,omitempty"`
 	SeparatePullRequestStatuses             *bool   `json:"separate_pull_request_statuses,omitempty"`
+	IgnoreDefaultBranchPullRequests         *bool   `json:"ignore_default_branch_pull_requests"`
 }
 
 func getPipelineExtraInfo(ctx context.Context, client *Client, slug string, timeouts time.Duration) (*PipelineExtraInfo, error) {
@@ -1113,6 +1120,7 @@ func updatePipelineExtraInfo(ctx context.Context, slug string, settings *provide
 			PublishBlockedAsPending:                 settings.PublishBlockedAsPending.ValueBoolPointer(),
 			PublishCommitStatusPerStep:              settings.PublishCommitStatusPerStep.ValueBoolPointer(),
 			SeparatePullRequestStatuses:             settings.SeparatePullRequestStatuses.ValueBoolPointer(),
+			IgnoreDefaultBranchPullRequests:         settings.IgnoreDefaultBranchPullRequests.ValueBoolPointer(),
 		},
 	}
 
@@ -1162,6 +1170,7 @@ func updatePipelineResourceExtraInfo(state *pipelineResourceModel, pipeline *Pip
 		PublishBlockedAsPending:                 types.BoolPointerValue(s.PublishBlockedAsPending),
 		PublishCommitStatusPerStep:              types.BoolPointerValue(s.PublishCommitStatusPerStep),
 		SeparatePullRequestStatuses:             types.BoolPointerValue(s.SeparatePullRequestStatuses),
+		IgnoreDefaultBranchPullRequests:         types.BoolPointerValue(s.IgnoreDefaultBranchPullRequests),
 	}
 }
 
@@ -1402,6 +1411,10 @@ func pipelineSchemaV0() schema.Schema {
 							Computed: true,
 							Optional: true,
 						},
+						"ignore_default_branch_pull_requests": schema.BoolAttribute{
+							Computed: true,
+							Optional: true,
+						},
 					},
 				},
 			},

buildkite/resource_pipeline_test.go

@@ -646,6 +646,7 @@ func TestAccBuildkitePipelineResource(t *testing.T) {
 								publish_blocked_as_pending = true
 								publish_commit_status_per_step = true
 								separate_pull_request_statuses = true
+								ignore_default_branch_pull_requests = true
 							}
 						}
 					`, clusterName, pipelineName),
@@ -659,6 +660,7 @@ func TestAccBuildkitePipelineResource(t *testing.T) {
 							return nil
 						},
 						resource.TestCheckResourceAttrPair("buildkite_pipeline.pipeline", "cluster_id", "buildkite_cluster.cluster", "id"),
+						resource.TestCheckResourceAttr("buildkite_pipeline.pipeline", "provider_settings.ignore_default_branch_pull_requests", "true"),
 						aggregateRemoteCheck(&pipeline),
 					),
 				},

docs/resources/pipeline.md

@@ -177,6 +177,7 @@ Optional:
 - `cancel_deleted_branch_builds` (Boolean) Automatically cancel running builds for a branch if the branch is deleted.
 - `filter_condition` (String) The condition to evaluate when deciding if a build should run. More details available in [the documentation](https://buildkite.com/docs/pipelines/conditionals#conditionals-in-pipelines).
 - `filter_enabled` (Boolean) Whether to filter builds to only run when the condition in `filter_condition` is true.
+- `ignore_default_branch_pull_requests` (Boolean) Whether to prevent caching pull requests with the source branch matching the default branch.
 - `prefix_pull_request_fork_branch_names` (Boolean) Prefix branch names for third-party fork builds to ensure they don't trigger branch conditions. For example, the main branch from some-user will become some-user:main.
 - `publish_blocked_as_pending` (Boolean) The status to use for blocked builds. Pending can be used with [required status checks](https://help.github.com/en/articles/enabling-required-status-checks) to prevent merging pull requests with blocked builds.
 - `publish_commit_status` (Boolean) Whether to update the status of commits in Bitbucket or GitHub.