Merge pull request #163 from buildkite/fix_make_webhook_required

fix: when creating a pipeline we require the create_webhook to be set

Author: wolfeidau

pkg/buildkite/pipelines.go

@@ -294,7 +294,7 @@ type CreatePipelineArgs struct {
 	SkipQueuedBranchBuilds    bool     `json:"skip_queued_branch_builds"`
 	CancelRunningBranchBuilds bool     `json:"cancel_running_branch_builds"`
 	Tags                      []string `json:"tags"`
-	CreateWebhook             *bool    `json:"create_webhook"`
+	CreateWebhook             bool     `json:"create_webhook"`
 }
 
 func CreatePipeline(client PipelinesClient) (tool mcp.Tool, handler mcp.TypedToolHandlerFunc[CreatePipelineArgs], scopes []string) {
@@ -317,6 +317,11 @@ func CreatePipeline(client PipelinesClient) (tool mcp.Tool, handler mcp.TypedToo
 				mcp.Required(),
 				mcp.Description("The pipeline configuration in YAML format. Contains the build steps and pipeline settings. If not provided, a basic configuration will be used"),
 			),
+			mcp.WithBoolean("create_webhook",
+				mcp.Required(),
+				mcp.Description("Create a GitHub webhook to trigger builds in response to pull-request and push events"),
+				mcp.DefaultBool(true),
+			),
 			mcp.WithString("description"),
 			mcp.WithString("default_branch",
 				mcp.Description("The default branch for builds and metrics filtering"),
@@ -327,10 +332,6 @@ func CreatePipeline(client PipelinesClient) (tool mcp.Tool, handler mcp.TypedToo
 			mcp.WithBoolean("cancel_running_branch_builds",
 				mcp.Description("Cancel running builds when new builds are created on the same branch"),
 			),
-			mcp.WithBoolean("create_webhook",
-				mcp.Description("Create a GitHub webhook to trigger builds in response to pull-request and push events"),
-				mcp.DefaultBool(true),
-			),
 			mcp.WithArray("tags",
 				mcp.Description("Tags to apply to the pipeline. These can be used for filtering and organization"),
 				mcp.Items(map[string]any{
@@ -371,6 +372,7 @@ func CreatePipeline(client PipelinesClient) (tool mcp.Tool, handler mcp.TypedToo
 			span.SetAttributes(
 				attribute.String("name", args.Name),
 				attribute.String("repository_url", args.RepositoryURL),
+				attribute.Bool("create_webhook", args.CreateWebhook),
 			)
 
 			create := buildkite.CreatePipeline{
@@ -400,13 +402,7 @@ func CreatePipeline(client PipelinesClient) (tool mcp.Tool, handler mcp.TypedToo
 				return mcp.NewToolResultError(err.Error()), nil
 			}
 
-			// create webhooks by default to align with the behavior in the dashboard
-			createWebhook := true
-			if args.CreateWebhook != nil {
-				createWebhook = *args.CreateWebhook
-			}
-
-			if createWebhook {
+			if args.CreateWebhook {
 				_, err := client.AddWebhook(ctx, args.OrgSlug, pipeline.Slug)
 				result := CreatePipelineResult{
 					Pipeline: pipeline,

pkg/buildkite/pipelines_test.go

@@ -197,12 +197,12 @@ steps:
 		Description:   "A test pipeline",
 		Configuration: testPipelineDefinition,
 		Tags:          []string{"tag1", "tag2"},
-		CreateWebhook: nil,
+		CreateWebhook: true, // should create webhook by default
 	}
 
 	result, err := handler(ctx, request, args)
 	assert.NoError(err)
-	assert.True(webhookCalled, "AddWebhook should have been called when CreateWebhook is nil")
+	assert.True(webhookCalled, "AddWebhook should have been called when CreateWebhook is true")
 
 	textContent := getTextResult(t, result)
 	assert.Contains(textContent.Text, `"webhook":{"created":true,"note":"Pipeline and webhook created successfully."}`)
@@ -225,7 +225,6 @@ steps:
 
 	ctx := context.Background()
 	webhookCalled := false
-	createWebhook := true
 	client := &MockPipelinesClient{
 		CreateFunc: func(ctx context.Context, org string, p buildkite.CreatePipeline) (buildkite.Pipeline, *buildkite.Response, error) {
 
@@ -278,7 +277,7 @@ steps:
 		Description:   "A test pipeline",
 		Configuration: testPipelineDefinition,
 		Tags:          []string{"tag1", "tag2"},
-		CreateWebhook: &createWebhook,
+		CreateWebhook: true,
 	}
 
 	result, err := handler(ctx, request, args)
@@ -306,7 +305,6 @@ steps:
 
 	ctx := context.Background()
 	webhookCalled := false
-	createWebhook := true
 	client := &MockPipelinesClient{
 		CreateFunc: func(ctx context.Context, org string, p buildkite.CreatePipeline) (buildkite.Pipeline, *buildkite.Response, error) {
 
@@ -350,7 +348,7 @@ steps:
 		Description:   "A test pipeline",
 		Configuration: testPipelineDefinition,
 		Tags:          []string{"tag1", "tag2"},
-		CreateWebhook: &createWebhook,
+		CreateWebhook: true,
 	}
 
 	result, err := handler(ctx, request, args)