feat: support edited comment events for Github

config/302-pac-configmap.yaml

@@ -237,6 +237,11 @@ data:
   # step of a task using StepActions. Set it to false to only report the tasks.
   status-show-steps: "true"
 
+  # Enable or disable the feature to support edited comments events.
+  # When enabled, edited comments will be processed and PipelineRuns will be triggered on them.
+  # Default: false
+  support-edited-comments: "false"
+
 kind: ConfigMap
 metadata:
   name: pipelines-as-code

docs/content/docs/api/configmap.md

@@ -399,6 +399,22 @@ require-ok-to-test-sha: "false"
 
 {{< /param >}}
 
+{{< tech_preview "Support for edited comments" >}}
+
+{{< param name="support-edited-comments" type="boolean" default="false" id="param-support-edited-comments" >}}
+
+Enables processing of edited comment events. When enabled, editing a comment that contains a GitOps command (such as `/test` or `/retest`) triggers the command as if it were a new comment. This is useful when you need to fix a typo in a command or change a PipelineRun name without posting a new comment.
+
+When disabled (the default), only newly created comments trigger PipelineRuns. Edited comments are ignored.
+
+Currently supported on GitHub only.
+
+```yaml
+support-edited-comments: "false"
+```
+
+{{< /param >}}
+
 {{< param name="skip-push-event-for-pr-commits" type="boolean" default="true" id="param-skip-push-event-for-pr-commits" >}}
 Prevents duplicate PipelineRuns when a commit appears in both a push event and a pull request. When a push event arrives from a commit that belongs to an open pull request, Pipelines-as-Code skips the push event.
 

docs/content/docs/guides/gitops-commands/_index.md

@@ -74,3 +74,24 @@ Pipeline execution appears to be unstable due to external factors. Retesting thi
 {{< callout type="info" >}}
 GitOps commands such as `/test` and others do not work on closed pull requests or merge requests.
 {{< /callout >}}
+
+### Edited Comments
+
+{{< tech_preview "Support for edited comments" >}}
+{{< support_matrix github_app="true" github_webhook="true" forgejo="false" gitlab="false" bitbucket_cloud="false" bitbucket_datacenter="false" >}}
+
+By default, Pipelines-as-Code only processes **newly created** comments. If you edit an existing comment to add or change a GitOps command, it is ignored.
+
+When the `support-edited-comments` setting is enabled in the [Pipelines-as-Code ConfigMap]({{< relref "/docs/api/configmap" >}}), edited comments are processed just like new ones. This means you can edit a comment to fix a typo in a command or change a PipelineRun name, and Pipelines-as-Code triggers the updated command.
+
+To enable this feature, set the following in the `pipelines-as-code` ConfigMap:
+
+```yaml
+support-edited-comments: "true"
+```
+
+Pipelines-as-Code fetches pull request details from the GitHub API before checking a comment for GitOps commands. Enabling edited comment support also makes this API request for each processed comment edit, including edits to ordinary comments or commands intended for other CI systems. Each request counts toward the API rate limit of the token used by Pipelines-as-Code.
+
+{{< callout type="warning" >}}
+Enabling edited comment support means that editing any comment on a pull request that contains a GitOps command (such as `/test` or `/retest`) will re-trigger the associated PipelineRuns. Be cautious when editing older comments that contain commands.
+{{< /callout >}}

pkg/adapter/adapter.go

@@ -233,7 +233,7 @@ func (l listener) handleEvent(ctx context.Context) http.HandlerFunc {
 		if isIncoming {
 			gitProvider, logger, err = l.processIncoming(event, targettedRepo)
 		} else {
-			gitProvider, logger, err = l.detectProvider(request, string(payload))
+			gitProvider, logger, err = l.detectProvider(request, string(payload), &pacInfo)
 		}
 
 		// figure out which provider request coming from
@@ -335,7 +335,7 @@ func (l listener) processRes(processEvent bool, provider provider.Interface, log
 	return nil, logger, fmt.Errorf("skipping non supported event")
 }
 
-func (l listener) detectProvider(req *http.Request, reqBody string) (provider.Interface, *zap.SugaredLogger, error) {
+func (l listener) detectProvider(req *http.Request, reqBody string, pacInfo *info.PacOpts) (provider.Interface, *zap.SugaredLogger, error) {
 	log := *l.logger
 
 	// payload validation
@@ -346,6 +346,7 @@ func (l listener) detectProvider(req *http.Request, reqBody string) (provider.In
 
 	gitHub := github.New()
 	gitHub.Run = l.run
+	gitHub.SetPacInfo(pacInfo)
 	isGH, processReq, logger, reason, err := gitHub.Detect(req, reqBody, &log)
 	if isGH {
 		return l.processRes(processReq, gitHub, logger, reason, err)

pkg/adapter/adapter_test.go

@@ -269,7 +269,7 @@ func TestWhichProvider(t *testing.T) {
 				Header: tt.header,
 			}
 
-			_, _, err = l.detectProvider(req, string(jeez))
+			_, _, err = l.detectProvider(req, string(jeez), &info.PacOpts{})
 			if tt.wantErrString != "" {
 				assert.ErrorContains(t, err, tt.wantErrString)
 				return
@@ -359,9 +359,10 @@ func TestDetectProviderAdditionalProviders(t *testing.T) {
 				assert.NilError(t, err)
 				body = string(payload)
 			}
+			pacInfo := &info.PacOpts{}
 
 			req := &http.Request{Header: tt.header}
-			gotProvider, gotLogger, err := l.detectProvider(req, body)
+			gotProvider, gotLogger, err := l.detectProvider(req, body, pacInfo)
 			assert.NilError(t, err)
 			assert.Assert(t, gotProvider != nil)
 			assert.Assert(t, gotLogger != nil)

pkg/params/settings/config.go

@@ -108,6 +108,9 @@ type Settings struct {
 	RememberOKToTest   bool `json:"remember-ok-to-test"`
 	RequireOkToTestSHA bool `json:"require-ok-to-test-sha"`
 
+	// SupportEditedComments enables or disables the feature to support edited comments events.
+	SupportEditedComments bool `default:"false" json:"support-edited-comments"`
+
 	// Retry Git provider API requests on rate limits and transient errors.
 	// Disabled by default.
 	EnableAPIRetry         bool `default:"false" json:"enable-api-retry"`

pkg/params/settings/config_test.go

@@ -42,6 +42,7 @@ func TestSyncConfig(t *testing.T) {
 				EnableCancelInProgressOnPullRequests: false,
 				EnableCancelInProgressOnPush:         false,
 				SkipPushEventForPRCommits:            true,
+				SupportEditedComments:                false,
 				StatusShowSteps:                      true,
 				CustomConsoleName:                    "",
 				CustomConsoleURL:                     "",
@@ -80,6 +81,7 @@ func TestSyncConfig(t *testing.T) {
 				"custom-console-url-namespace":            "https://custom-console-namespace",
 				"remember-ok-to-test":                     "false",
 				"skip-push-event-for-pr-commits":          "true",
+				"support-edited-comments":                 "false",
 				"require-ok-to-test-sha":                  "true",
 			},
 			expectedStruct: Settings{
@@ -105,6 +107,7 @@ func TestSyncConfig(t *testing.T) {
 				EnableCancelInProgressOnPullRequests: false,
 				EnableCancelInProgressOnPush:         false,
 				SkipPushEventForPRCommits:            true,
+				SupportEditedComments:                false,
 				StatusShowSteps:                      true,
 				CustomConsoleName:                    "custom-console",
 				CustomConsoleURL:                     "https://custom-console",

pkg/provider/github/detect.go

@@ -76,7 +76,8 @@ func (v *Provider) detectTriggerTypeFromPayload(ghEventType string, eventInt any
 		}
 		return "", fmt.Sprintf("pull_request: unsupported action \"%s\"", event.GetAction())
 	case *github.IssueCommentEvent:
-		if event.GetAction() != "created" {
+		isEdiCommentEvent := event.GetAction() == "edited" && v.pacInfo.SupportEditedComments
+		if event.GetAction() != "created" && !isEdiCommentEvent {
 			return "", fmt.Sprintf("issue_comment: unsupported action \"%s\"", event.GetAction())
 		}
 
@@ -104,7 +105,8 @@ func (v *Provider) detectTriggerTypeFromPayload(ghEventType string, eventInt any
 		}
 		return "", fmt.Sprintf("check_run: unsupported action \"%s\"", event.GetAction())
 	case *github.CommitCommentEvent:
-		if event.GetAction() != "created" {
+		isEdiCommentEvent := event.GetAction() == "edited" && v.pacInfo.SupportEditedComments
+		if event.GetAction() != "created" && !isEdiCommentEvent {
 			return "", fmt.Sprintf("commit_comment: unsupported action \"%s\"", event.GetAction())
 		}
 

pkg/provider/github/detect_test.go

@@ -7,20 +7,22 @@ import (
 	"testing"
 
 	"github.com/google/go-github/v91/github"
+	"github.com/openshift-pipelines/pipelines-as-code/pkg/params/info"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/test/logger"
 	"gotest.tools/v3/assert"
 )
 
 func TestProviderDetect(t *testing.T) {
 	idd := int64(123)
 	tests := []struct {
-		name          string
-		wantErrString string
-		isGH          bool
-		processReq    bool
-		event         any
-		eventType     string
-		wantReason    string
+		name                  string
+		wantErrString         string
+		isGH                  bool
+		processReq            bool
+		event                 any
+		supportEditedComments bool
+		eventType             string
+		wantReason            string
 	}{
 		{
 			name:       "not a github Event",
@@ -267,6 +269,47 @@ func TestProviderDetect(t *testing.T) {
 			isGH:       true,
 			processReq: true,
 		},
+		{
+			name: "issue comment Event with edited action",
+			event: github.IssueCommentEvent{
+				Action: new("edited"),
+				Issue: &github.Issue{
+					PullRequestLinks: &github.PullRequestLinks{
+						URL: new("url"),
+					},
+					State: new("open"),
+				},
+				Installation: &github.Installation{
+					ID: &idd,
+				},
+				Comment: &github.IssueComment{Body: new("I am edited")},
+			},
+			eventType:             "issue_comment",
+			supportEditedComments: true,
+			isGH:                  true,
+			processReq:            true,
+		},
+		{
+			name: "issue comment Event with edited action and support edited comments is disabled",
+			event: github.IssueCommentEvent{
+				Action: new("edited"),
+				Issue: &github.Issue{
+					PullRequestLinks: &github.PullRequestLinks{
+						URL: new("url"),
+					},
+					State: new("open"),
+				},
+				Installation: &github.Installation{
+					ID: &idd,
+				},
+				Comment: &github.IssueComment{Body: new("I am edited")},
+			},
+			eventType:             "issue_comment",
+			supportEditedComments: false,
+			isGH:                  true,
+			processReq:            false,
+			wantReason:            "issue_comment: unsupported action \"edited\"",
+		},
 		{
 			name: "commit comment event with cancel comment",
 			event: github.CommitCommentEvent{
@@ -280,6 +323,33 @@ func TestProviderDetect(t *testing.T) {
 			isGH:       true,
 			processReq: true,
 		},
+		{
+			name: "commit comment Event with edited action",
+			event: github.CommitCommentEvent{
+				Action: new("edited"),
+				Installation: &github.Installation{
+					ID: &idd,
+				},
+			},
+			eventType:             "commit_comment",
+			supportEditedComments: true,
+			isGH:                  true,
+			processReq:            true,
+		},
+		{
+			name: "commit comment Event with edited action and support edited comments is disabled",
+			event: github.CommitCommentEvent{
+				Action: new("edited"),
+				Installation: &github.Installation{
+					ID: &idd,
+				},
+			},
+			eventType:             "commit_comment",
+			supportEditedComments: false,
+			isGH:                  true,
+			processReq:            false,
+			wantReason:            "commit_comment: unsupported action \"edited\"",
+		},
 		{
 			name: "commit comment Event with retest",
 			event: github.CommitCommentEvent{
@@ -323,7 +393,11 @@ func TestProviderDetect(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			gprovider := Provider{}
+			gprovider := Provider{
+				pacInfo: &info.PacOpts{
+					SupportEditedComments: tt.supportEditedComments,
+				},
+			}
 			logger, logCatcher := logger.GetLogger()
 			jeez, err := json.Marshal(tt.event)
 			if err != nil {