Disable Github comments for pipeline start/end events to reduce PR noise

The Github webhook integration was previously generating a comment on every
pipeline start and end filling pull requests with redundant updates

Hence this patch introduces a new setting to completely disable
comment creation

By using `comment_strategy: disable_all`, no comments will be added
for either pipeline start or completion

Also includes e2e tests to validate the new behavior

Signed-off-by: PuneetPunamiya <[email protected]>

Author: PuneetPunamiya

config/300-repositories.yaml

@@ -334,6 +334,18 @@ spec:
                     Settings contains the configuration settings for the repository, including
                     authorization policies, provider-specific configuration, and provenance settings.
                   properties:
+                    github:
+                      properties:
+                        comment_strategy:
+                          description: |-
+                            CommentStrategy defines how GitLab comments are handled for pipeline results.
+                            Options:
+                            - 'disable_all': Disables all comments on merge requests
+                          enum:
+                            - ""
+                            - disable_all
+                          type: string
+                      type: object
                     github_app_token_scope_repos:
                       description: |-
                         GithubAppTokenScopeRepos lists repositories that can access the GitHub App token when using the

docs/content/docs/guide/repositorycrd.md

@@ -134,6 +134,19 @@ spec:
 
 When you set the value of `comment_strategy` to `disable_all` it will not add any comment on the merge request for the start and the end of pipelinerun
 
+## Disabling all comments for Pipelineruns in GitHub Pull Requests on GitHub Webhook Setup
+
+`comment_strategy` allows you to disable the comments on GitHub PR for a Repository
+
+```yaml
+spec:
+  settings:
+    github:
+      comment_strategy: "disable_all"
+```
+
+When `comment_strategy` is set to `disable_all` Pipelines as Code will not create any comment on the pull request for PipelineRun Status
+
 ## Concurrency
 
 `concurrency_limit` allows you to define the maximum number of PipelineRuns running at any time for a Repository.

pkg/apis/pipelinesascode/v1alpha1/types.go

@@ -158,6 +158,8 @@ type Settings struct {
 	// Gitlab contains GitLab-specific settings for repositories hosted on GitLab.
 	// +optional
 	Gitlab *GitlabSettings `json:"gitlab,omitempty"`
+
+	Github *GithubSettings `json:"github,omitempty"`
 }
 
 type GitlabSettings struct {
@@ -169,6 +171,15 @@ type GitlabSettings struct {
 	CommentStrategy string `json:"comment_strategy,omitempty"`
 }
 
+type GithubSettings struct {
+	// CommentStrategy defines how GitLab comments are handled for pipeline results.
+	// Options:
+	// - 'disable_all': Disables all comments on merge requests
+	// +optional
+	// +kubebuilder:validation:Enum="";disable_all
+	CommentStrategy string `json:"comment_strategy,omitempty"`
+}
+
 func (s *Settings) Merge(newSettings *Settings) {
 	if newSettings.PipelineRunProvenance != "" && s.PipelineRunProvenance == "" {
 		s.PipelineRunProvenance = newSettings.PipelineRunProvenance

pkg/provider/github/status.go

@@ -332,16 +332,27 @@ func (v *Provider) createStatusCommit(ctx context.Context, runevent *info.Event,
 		eventType = triggertype.PullRequest
 	}
 
-	if (status.Status == "completed" || (status.Status == "queued" && status.Title == pendingApproval)) &&
-		status.Text != "" && eventType == triggertype.PullRequest {
-		_, _, err = v.Client().Issues.CreateComment(ctx, runevent.Organization, runevent.Repository,
-			runevent.PullRequestNumber,
-			&github.IssueComment{
-				Body: github.Ptr(fmt.Sprintf("%s<br>%s", status.Summary, status.Text)),
-			},
-		)
-		if err != nil {
-			return err
+	var commentStrategy string
+	if v.repo != nil && v.repo.Spec.Settings != nil && v.repo.Spec.Settings.Github != nil {
+		commentStrategy = v.repo.Spec.Settings.Github.CommentStrategy
+	}
+
+	switch commentStrategy {
+	case "disable_all":
+		v.Logger.Warn("github: comments related to PipelineRuns status have been disabled for Github pull requests")
+		return nil
+	default:
+		if (status.Status == "completed" || (status.Status == "queued" && status.Title == pendingApproval)) &&
+			status.Text != "" && eventType == triggertype.PullRequest {
+			_, _, err = v.Client().Issues.CreateComment(ctx, runevent.Organization, runevent.Repository,
+				runevent.PullRequestNumber,
+				&github.IssueComment{
+					Body: github.Ptr(fmt.Sprintf("%s<br>%s", status.Summary, status.Text)),
+				},
+			)
+			if err != nil {
+				return err
+			}
 		}
 	}
 

test/github_pullrequest_test.go

@@ -10,6 +10,7 @@ import (
 	"time"
 
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/apis/pipelinesascode/keys"
+	"github.com/openshift-pipelines/pipelines-as-code/pkg/apis/pipelinesascode/v1alpha1"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/opscomments"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/params"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/params/info"
@@ -582,6 +583,40 @@ func TestGithubPullandPushMatchTriggerOnlyPull(t *testing.T) {
 	assert.NilError(t, err)
 }
 
+func TestGithubDisableCommentsOnPR(t *testing.T) {
+	if os.Getenv("TEST_GITHUB_REPO_OWNER_WEBHOOK") == "" {
+		t.Skip("TEST_GITHUB_REPO_OWNER_WEBHOOK is not set")
+		return
+	}
+	ctx := context.Background()
+
+	g := &tgithub.PRTest{
+		Label:     "Github PullRequest onWebhook",
+		YamlFiles: []string{"testdata/pipelinerun.yaml"},
+		Webhook:   true,
+	}
+
+	commentStrategy := v1alpha1.Settings{
+		Github: &v1alpha1.GithubSettings{
+			CommentStrategy: "disable_all",
+		},
+	}
+
+	g.Options.Settings = commentStrategy
+	g.RunPullRequest(ctx, t)
+	defer g.TearDown(ctx, t)
+
+	comments, _, _ := g.Provider.Client().Issues.ListComments(ctx, g.Options.Organization, g.Options.Repo, g.PRNumber, nil)
+	commentRegexp := regexp.MustCompile(`.*Pipelines as Code CI/*`)
+	successCommentsPost := 0
+	for _, n := range comments {
+		if commentRegexp.MatchString(*n.Body) {
+			successCommentsPost++
+		}
+	}
+	assert.Equal(t, 0, successCommentsPost)
+}
+
 // Local Variables:
 // compile-command: "go test -tags=e2e -v -info TestGithubPullRequest$ ."
 // End:

test/pkg/github/crd.go

@@ -21,7 +21,8 @@ func CreateCRD(ctx context.Context, t *testing.T, repoinfo *ghlib.Repository, ru
 			Name: targetNS,
 		},
 		Spec: v1alpha1.RepositorySpec{
-			URL: repoinfo.GetHTMLURL(),
+			URL:      repoinfo.GetHTMLURL(),
+			Settings: &opts.Settings,
 		},
 	}
 

test/pkg/github/pr.go

@@ -137,6 +137,9 @@ func (g *PRTest) RunPullRequest(ctx context.Context, t *testing.T) {
 		t.Errorf("Repository %s not found in %s", opts.Organization, opts.Repo)
 	}
 
+	if g.Options.Settings.Github != nil {
+		opts.Settings = g.Options.Settings
+	}
 	err = CreateCRD(ctx, t, repoinfo, runcnx, opts, targetNS)
 	assert.NilError(t, err)