feat: Enable cluster wide setting for cancel-in-progress

currently, cancel-in-progress can be configured only on
PipelineRun level via cancel-in-progress annotation.
This PR introduces new setting in Pipelines as Code
ConfigMap with enable-cancel-in-progress-on-pull-requests and
enable-cancel-in-progress-on-push to control cancel-in-progress
functionality on deployment level.

when enable-cancel-in-progress-on-pull-requests is set to true
all the PipelineRun will be cancelled on PR close and on PR
update when a commit is pushed on the head branch of PR and
same for push setting. a PipelineRun will override configmap
setting if it has cancel-in-progress annotation explicitly
and PAC will do accordingly.

https://issues.redhat.com/browse/SRVKP-6910

Signed-off-by: Zaki Shaikh <zashaikh@redhat.com>

Author: zakisk

config/302-pac-configmap.yaml

@@ -90,6 +90,18 @@ data:
   error-detection-simple-regexp: |-
     ^(?P<filename>[^:]*):(?P<line>[0-9]+):(?P<column>[0-9]+)?([ ]*)?(?P<error>.*)
 
+  # Global setting to control whether Pipelines-as-Code should automatically cancel
+  # any in-progress PipelineRuns associated with a pull request when that pull request is updated.
+  # This helps prevent multiple redundant runs from executing simultaneously.
+  # Default value: false.
+  enable-cancel-in-progress-on-pull-requests: "false"
+
+  # Global setting to determine whether Pipelines-as-Code should automatically cancel
+  # in-progress PipelineRuns triggered by a push event, if a new push occurs on the same branch.
+  # This prevents overlapping or redundant runs for the same branch.
+  # Default value: false.
+  enable-cancel-in-progress-on-push: "false"
+
   # Since public bitbucket doesn't have the concept of Secret, we need to be
   # able to secure the request by querying https://ip-ranges.atlassian.com/,
   # this only happen for public bitbucket (ie: when provider.url is not set in

docs/content/docs/install/operator_installation.md

@@ -33,6 +33,8 @@ spec:
           auto-configure-new-github-repo: 'false'
           error-log-snippet: 'true'
           error-detection-from-container-logs: 'false'
+          enable-cancel-in-progress-on-pull-requests: 'false'
+          enable-cancel-in-progress-on-push: 'false'
           hub-url: 'https://api.hub.tekton.dev/v1'
           hub-catalog-name: tekton
           error-detection-max-number-of-lines: '50'

docs/content/docs/install/settings.md

@@ -139,6 +139,32 @@ There is a few things you can configure through the config map
   risk and should be aware of the potential security vulnerabilities.
   (only GitHub and Gitea is supported at the moment).
 
+### Global Cancel In Progress Settings
+
+* `enable-cancel-in-progress-on-pull-requests`
+
+  If the `enable-cancel-in-progress-on-pull-requests` setting is enabled (true), Pipelines-as-Code will automatically cancel
+  any in-progress PipelineRuns associated with a pull request when a new update (such as a new commit) is pushed to that pull request.
+  This ensures that only the latest commit is processed, helping conserve compute resources and avoid running outdated PipelineRuns
+  tied to previous commits.
+
+  It's important to note that if this global setting is disabled (false), Pipelines-as-Code will still honor the cancel-in-progress annotation
+  at the individual PipelineRun level. In such cases, if a PipelineRun includes this annotation, it will take precedence over the global setting,
+  and Pipelines-as-Code will cancel any matching in-progress runs when the pull request is updated.
+
+  This is disabled by default.
+
+* `enable-cancel-in-progress-on-push`
+
+  If the `enable-cancel-in-progress-on-push` setting is enabled (true), Pipelines-as-Code will automatically cancel any in-progress PipelineRuns
+  triggered by a push event when a new push is made to the same branch. This helps ensure that only the most recent commit is processed, preventing unnecessary execution of outdated PipelineRuns and optimizing resource usage.
+
+  Additionally, if this global setting is disabled (false), Pipelines-as-Code will still respect the cancel-in-progress annotation
+  on individual PipelineRuns. In such cases, the annotation will override the global configuration, and Pipelines-as-Code will
+  cancel any in-progress runs for that specific PipelineRun when a new push occurs on the same branch.
+
+  This is disabled by default.
+
 ### Tekton Hub support
 
 Pipelines-as-Code supports fetching task with its remote annotations feature, by default it will fetch it from the [public tekton hub](https://hub.tekton.dev/) but you can configure it to point to your own with these settings:

pkg/params/settings/config.go

@@ -63,6 +63,9 @@ type Settings struct {
 	ErrorDetectionNumberOfLines int    `default:"50"                                                                            json:"error-detection-max-number-of-lines"`
 	ErrorDetectionSimpleRegexp  string `default:"^(?P<filename>[^:]*):(?P<line>[0-9]+):(?P<column>[0-9]+)?([ ]*)?(?P<error>.*)" json:"error-detection-simple-regexp"`
 
+	EnableCancelInProgressOnPullRequests bool `json:"enable-cancel-in-progress-on-pull-requests"`
+	EnableCancelInProgressOnPush         bool `json:"enable-cancel-in-progress-on-push"`
+
 	CustomConsoleName         string `json:"custom-console-name"`
 	CustomConsoleURL          string `json:"custom-console-url"`
 	CustomConsolePRdetail     string `json:"custom-console-url-pr-details"`

pkg/params/settings/config_test.go

@@ -21,29 +21,31 @@ func TestSyncConfig(t *testing.T) {
 			name:      "With all default values",
 			configMap: map[string]string{},
 			expectedStruct: Settings{
-				ApplicationName:                    "Pipelines as Code CI",
-				HubCatalogs:                        nil,
-				RemoteTasks:                        true,
-				MaxKeepRunsUpperLimit:              0,
-				DefaultMaxKeepRuns:                 0,
-				BitbucketCloudCheckSourceIP:        true,
-				BitbucketCloudAdditionalSourceIP:   "",
-				TektonDashboardURL:                 "",
-				AutoConfigureNewGitHubRepo:         false,
-				AutoConfigureRepoNamespaceTemplate: "",
-				SecretAutoCreation:                 true,
-				SecretGHAppRepoScoped:              true,
-				SecretGhAppTokenScopedExtraRepos:   "",
-				ErrorLogSnippet:                    true,
-				ErrorDetection:                     true,
-				ErrorDetectionNumberOfLines:        50,
-				ErrorDetectionSimpleRegexp:         "^(?P<filename>[^:]*):(?P<line>[0-9]+):(?P<column>[0-9]+)?([ ]*)?(?P<error>.*)",
-				CustomConsoleName:                  "",
-				CustomConsoleURL:                   "",
-				CustomConsolePRdetail:              "",
-				CustomConsolePRTaskLog:             "",
-				CustomConsoleNamespaceURL:          "",
-				RememberOKToTest:                   false,
+				ApplicationName:                      "Pipelines as Code CI",
+				HubCatalogs:                          nil,
+				RemoteTasks:                          true,
+				MaxKeepRunsUpperLimit:                0,
+				DefaultMaxKeepRuns:                   0,
+				BitbucketCloudCheckSourceIP:          true,
+				BitbucketCloudAdditionalSourceIP:     "",
+				TektonDashboardURL:                   "",
+				AutoConfigureNewGitHubRepo:           false,
+				AutoConfigureRepoNamespaceTemplate:   "",
+				SecretAutoCreation:                   true,
+				SecretGHAppRepoScoped:                true,
+				SecretGhAppTokenScopedExtraRepos:     "",
+				ErrorLogSnippet:                      true,
+				ErrorDetection:                       true,
+				ErrorDetectionNumberOfLines:          50,
+				ErrorDetectionSimpleRegexp:           "^(?P<filename>[^:]*):(?P<line>[0-9]+):(?P<column>[0-9]+)?([ ]*)?(?P<error>.*)",
+				EnableCancelInProgressOnPullRequests: false,
+				EnableCancelInProgressOnPush:         false,
+				CustomConsoleName:                    "",
+				CustomConsoleURL:                     "",
+				CustomConsolePRdetail:                "",
+				CustomConsolePRTaskLog:               "",
+				CustomConsoleNamespaceURL:            "",
+				RememberOKToTest:                     false,
 			},
 		},
 		{