feat: add use_step_key_as_commit_status provider setting (#1146)

Author: omarjatoi

buildkite/resource_pipeline.go

@@ -124,6 +124,7 @@ type providerSettingsModel struct {
 	PublishCommitStatus                     types.Bool   `tfsdk:"publish_commit_status"`
 	PublishBlockedAsPending                 types.Bool   `tfsdk:"publish_blocked_as_pending"`
 	PublishCommitStatusPerStep              types.Bool   `tfsdk:"publish_commit_status_per_step"`
+	UseStepKeyAsCommitStatus                types.Bool   `tfsdk:"use_step_key_as_commit_status"`
 	SeparatePullRequestStatuses             types.Bool   `tfsdk:"separate_pull_request_statuses"`
 	IgnoreDefaultBranchPullRequests         types.Bool   `tfsdk:"ignore_default_branch_pull_requests"`
 	BuildMergeGroupChecksRequested          types.Bool   `tfsdk:"build_merge_group_checks_requested"`
@@ -949,6 +950,14 @@ func (*pipelineResource) Schema(ctx context.Context, req resource.SchemaRequest,
 							boolplanmodifier.UseNonNullStateForUnknown(),
 						},
 					},
+					"use_step_key_as_commit_status": schema.BoolAttribute{
+						Computed:            true,
+						Optional:            true,
+						MarkdownDescription: "Whether to use step keys as commit status names for per-step commit statuses. Requires `publish_commit_status` and `publish_commit_status_per_step` to also be enabled. Defaults to false.",
+						PlanModifiers: []planmodifier.Bool{
+							boolplanmodifier.UseNonNullStateForUnknown(),
+						},
+					},
 					"separate_pull_request_statuses": schema.BoolAttribute{
 						Computed: true,
 						Optional: true,
@@ -1375,6 +1384,7 @@ type PipelineExtraSettings struct {
 	PublishCommitStatus                     *bool   `json:"publish_commit_status,omitempty"`
 	PublishBlockedAsPending                 *bool   `json:"publish_blocked_as_pending,omitempty"`
 	PublishCommitStatusPerStep              *bool   `json:"publish_commit_status_per_step,omitempty"`
+	UseStepKeyAsCommitStatus                *bool   `json:"use_step_key_as_commit_status,omitempty"`
 	SeparatePullRequestStatuses             *bool   `json:"separate_pull_request_statuses,omitempty"`
 	IgnoreDefaultBranchPullRequests         *bool   `json:"ignore_default_branch_pull_requests,omitempty"`
 	BuildMergeGroupChecksRequested          *bool   `json:"build_merge_group_checks_requested,omitempty"`
@@ -1441,6 +1451,7 @@ func updatePipelineExtraInfo(ctx context.Context, slug string, settings *provide
 			PublishCommitStatus:                     settings.PublishCommitStatus.ValueBoolPointer(),
 			PublishBlockedAsPending:                 settings.PublishBlockedAsPending.ValueBoolPointer(),
 			PublishCommitStatusPerStep:              settings.PublishCommitStatusPerStep.ValueBoolPointer(),
+			UseStepKeyAsCommitStatus:                settings.UseStepKeyAsCommitStatus.ValueBoolPointer(),
 			SeparatePullRequestStatuses:             settings.SeparatePullRequestStatuses.ValueBoolPointer(),
 			IgnoreDefaultBranchPullRequests:         settings.IgnoreDefaultBranchPullRequests.ValueBoolPointer(),
 			BuildMergeGroupChecksRequested:          settings.BuildMergeGroupChecksRequested.ValueBoolPointer(),
@@ -1498,6 +1509,7 @@ func updatePipelineResourceExtraInfo(state *pipelineResourceModel, pipeline *Pip
 		PublishCommitStatus:                     types.BoolPointerValue(s.PublishCommitStatus),
 		PublishBlockedAsPending:                 types.BoolPointerValue(s.PublishBlockedAsPending),
 		PublishCommitStatusPerStep:              types.BoolPointerValue(s.PublishCommitStatusPerStep),
+		UseStepKeyAsCommitStatus:                types.BoolPointerValue(s.UseStepKeyAsCommitStatus),
 		SeparatePullRequestStatuses:             types.BoolPointerValue(s.SeparatePullRequestStatuses),
 		IgnoreDefaultBranchPullRequests:         types.BoolPointerValue(s.IgnoreDefaultBranchPullRequests),
 		BuildMergeGroupChecksRequested:          types.BoolPointerValue(s.BuildMergeGroupChecksRequested),
@@ -1750,6 +1762,10 @@ func pipelineSchemaV0() schema.Schema {
 							Computed: true,
 							Optional: true,
 						},
+						"use_step_key_as_commit_status": schema.BoolAttribute{
+							Computed: true,
+							Optional: true,
+						},
 						"separate_pull_request_statuses": schema.BoolAttribute{
 							Computed: true,
 							Optional: true,

buildkite/resource_pipeline_test.go

@@ -2,6 +2,7 @@ package buildkite
 
 import (
 	"context"
+	"encoding/json"
 	"errors"
 	"fmt"
 	"log"
@@ -63,6 +64,47 @@ func testAccCheckPipelineDestroy(s *terraform.State) error {
 	return nil
 }
 
+func TestPipelineExtraSettingsUseStepKeyAsCommitStatusJSON(t *testing.T) {
+	enabled := true
+
+	payload, err := json.Marshal(PipelineExtraSettings{
+		UseStepKeyAsCommitStatus: &enabled,
+	})
+	if err != nil {
+		t.Fatalf("failed to marshal provider settings: %v", err)
+	}
+
+	if !strings.Contains(string(payload), `"use_step_key_as_commit_status":true`) {
+		t.Fatalf("expected use_step_key_as_commit_status in payload, got %s", payload)
+	}
+
+	payload, err = json.Marshal(PipelineExtraSettings{})
+	if err != nil {
+		t.Fatalf("failed to marshal empty provider settings: %v", err)
+	}
+
+	if strings.Contains(string(payload), "use_step_key_as_commit_status") {
+		t.Fatalf("expected use_step_key_as_commit_status to be omitted from empty payload, got %s", payload)
+	}
+}
+
+func TestUpdatePipelineResourceExtraInfoUseStepKeyAsCommitStatus(t *testing.T) {
+	enabled := true
+	extraInfo := PipelineExtraInfo{}
+	extraInfo.Provider.Settings.UseStepKeyAsCommitStatus = &enabled
+
+	state := pipelineResourceModel{}
+	updatePipelineResourceExtraInfo(&state, &extraInfo)
+
+	if state.ProviderSettings == nil {
+		t.Fatal("expected provider settings to be set")
+	}
+
+	if !state.ProviderSettings.UseStepKeyAsCommitStatus.ValueBool() {
+		t.Fatal("expected use_step_key_as_commit_status to be true")
+	}
+}
+
 func testAccCheckPipelineDestroyFunc(s *terraform.State) error {
 	return testAccCheckPipelineDestroy(s)
 }
@@ -566,6 +608,7 @@ func TestAccBuildkitePipelineResource(t *testing.T) {
 						resource.TestCheckResourceAttr("buildkite_pipeline.pipeline", "provider_settings.skip_pull_request_builds_for_existing_commits", "false"),
 						resource.TestCheckResourceAttr("buildkite_pipeline.pipeline", "provider_settings.build_branches", "false"),
 						resource.TestCheckResourceAttr("buildkite_pipeline.pipeline", "provider_settings.publish_commit_status", "false"),
+						resource.TestCheckResourceAttr("buildkite_pipeline.pipeline", "provider_settings.use_step_key_as_commit_status", "false"),
 					),
 				},
 			},
@@ -610,6 +653,7 @@ func TestAccBuildkitePipelineResource(t *testing.T) {
 					publish_commit_status = true
 					publish_blocked_as_pending = true
 					publish_commit_status_per_step = true
+					use_step_key_as_commit_status = true
 					separate_pull_request_statuses = true
 					build_merge_group_checks_requested = true
 					cancel_when_merge_group_destroyed = true
@@ -657,6 +701,7 @@ func TestAccBuildkitePipelineResource(t *testing.T) {
 						resource.TestCheckResourceAttr("buildkite_pipeline.pipeline", "provider_settings.publish_commit_status", "true"),
 						resource.TestCheckResourceAttr("buildkite_pipeline.pipeline", "provider_settings.publish_blocked_as_pending", "true"),
 						resource.TestCheckResourceAttr("buildkite_pipeline.pipeline", "provider_settings.publish_commit_status_per_step", "true"),
+						resource.TestCheckResourceAttr("buildkite_pipeline.pipeline", "provider_settings.use_step_key_as_commit_status", "true"),
 						resource.TestCheckResourceAttr("buildkite_pipeline.pipeline", "provider_settings.separate_pull_request_statuses", "true"),
 						resource.TestCheckResourceAttr("buildkite_pipeline.pipeline", "provider_settings.build_merge_group_checks_requested", "true"),
 						resource.TestCheckResourceAttr("buildkite_pipeline.pipeline", "provider_settings.cancel_when_merge_group_destroyed", "true"),
@@ -731,6 +776,7 @@ func TestAccBuildkitePipelineResource(t *testing.T) {
 								publish_commit_status = true
 								publish_blocked_as_pending = true
 								publish_commit_status_per_step = true
+								use_step_key_as_commit_status = true
 								separate_pull_request_statuses = true
 								ignore_default_branch_pull_requests = true
 								build_merge_group_checks_requested = true
@@ -757,6 +803,7 @@ func TestAccBuildkitePipelineResource(t *testing.T) {
 						resource.TestCheckResourceAttr("buildkite_pipeline.pipeline", "provider_settings.build_pull_request_merge_commits", "true"),
 						resource.TestCheckResourceAttr("buildkite_pipeline.pipeline", "provider_settings.build_pull_request_labels_changed", "true"),
 						resource.TestCheckResourceAttr("buildkite_pipeline.pipeline", "provider_settings.build_pull_request_base_branch_changed", "true"),
+						resource.TestCheckResourceAttr("buildkite_pipeline.pipeline", "provider_settings.use_step_key_as_commit_status", "true"),
 						resource.TestCheckResourceAttr("buildkite_pipeline.pipeline", "provider_settings.build_merge_group_checks_requested", "true"),
 						resource.TestCheckResourceAttr("buildkite_pipeline.pipeline", "provider_settings.cancel_when_merge_group_destroyed", "true"),
 						resource.TestCheckResourceAttr("buildkite_pipeline.pipeline", "provider_settings.use_merge_group_base_commit_for_git_diff_base", "true"),

docs/resources/pipeline.md

@@ -237,6 +237,7 @@ Optional:
 	-> `trigger_mode` is only valid if the pipeline uses a GitHub repository.
 	-> If not set, the default value is `code` and other provider settings defaults are applied.
 - `use_merge_group_base_commit_for_git_diff_base` (Boolean) When enabled, agents performing a git diff to determine steps to upload based on [`if_changed`](https://buildkite.com/docs/pipelines/configure/step-types/command-step#agent-applied-attributes)comparisons will use the base commit that points to the previous merge group rather than the base branch
+- `use_step_key_as_commit_status` (Boolean) Whether to use step keys as commit status names for per-step commit statuses. Requires `publish_commit_status` and `publish_commit_status_per_step` to also be enabled. Defaults to false.
 
 ## Import