feat: add skip CI command support

Implement support for skip CI commands in commit messages to allow
users to skip PipelineRun execution. Supports [skip ci], [ci skip],
[skip tkn], and [tkn skip] commands.

When a skip command is detected in the commit message, PipelineRun
execution is skipped. However, GitOps commands (/test, /retest, etc.)
will still trigger PipelineRuns regardless of the skip command,
allowing users to manually trigger CI when needed.

Skipping Tekton till tests are added [skip tkn]

Jira: https://issues.redhat.com/browse/SRVKP-8933

Signed-off-by: Akshay Pant <akshay.akshaypant@gmail.com>

Author: theakshaypant

pkg/params/info/events.go

@@ -43,6 +43,7 @@ type Event struct {
 	PullRequestTitle  string   // Title of the pull Request
 	PullRequestLabel  []string // Labels of the pull Request
 	TriggerComment    string   // The comment triggering the pipelinerun when using on-comment annotation
+	HasSkipCommand    bool     // Commit has command to skip PipelineRun
 
 	// TODO: move forge specifics to each driver
 	// Github

pkg/pipelineascode/pipelineascode.go

@@ -13,6 +13,7 @@ import (
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/formatting"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/kubeinteraction"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/matcher"
+	"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"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/params/settings"
@@ -89,7 +90,14 @@ func (p *PacRun) Run(ctx context.Context) error {
 	if repo.Spec.ConcurrencyLimit != nil && *repo.Spec.ConcurrencyLimit != 0 {
 		p.manager.Enable()
 	}
-
+	// Check skip logic after annotation matching, so that the EventType has been properly updated.
+	// In order for the PR to be skipped, the commit message should include the skip command.
+	// We don't want to skip the PR when the event is a GitOps command. For example, if the
+	// user has added `[skip ci]` to the commit, they don't need to push again to trigger the
+	// PipelineRun, they can simply add a comment to trigger the CI via `/test pr-name` or on-comment.
+	if p.event.HasSkipCommand && !opscomments.IsAnyOpsEventType(p.event.EventType) {
+		return nil
+	}
 	// set params for the console driver, only used for the custom console ones
 	cp := customparams.NewCustomParams(p.event, repo, p.run, p.k8int, p.eventEmitter, p.vcx)
 	maptemplate, _, err := cp.GetParams(ctx)

pkg/provider/bitbucketcloud/bitbucket.go

@@ -250,7 +250,7 @@ func (v *Provider) GetCommitInfo(_ context.Context, event *info.Event) error {
 	event.SHATitle = commitinfo.Message
 	event.SHAURL = commitinfo.Links.HTML.HRef
 	event.SHA = commitinfo.Hash
-
+	event.HasSkipCommand = provider.SkipCI(commitinfo.Message)
 	// now to get the default branch from repository.Get
 	repo, err := v.Client().Repositories.Repository.Get(&bitbucket.RepositoryOptions{
 		Owner:    event.Organization,

pkg/provider/bitbucketdatacenter/bitbucketdatacenter.go

@@ -339,6 +339,7 @@ func (v *Provider) GetCommitInfo(_ context.Context, event *info.Event) error {
 	}
 	event.SHATitle = sanitizeTitle(commit.Message)
 	event.SHAURL = fmt.Sprintf("%s/projects/%s/repos/%s/commits/%s", v.baseURL, v.projectKey, event.Repository, event.SHA)
+	event.HasSkipCommand = provider.SkipCI(commit.Message)
 
 	ref, _, err := v.Client().Git.GetDefaultBranch(context.Background(), OrgAndRepo)
 	if err != nil {

pkg/provider/gitea/gitea.go

@@ -377,6 +377,8 @@ func (v *Provider) GetCommitInfo(_ context.Context, runevent *info.Event) error
 	runevent.SHAURL = commit.HTMLURL
 	runevent.SHATitle = strings.Split(commit.RepoCommit.Message, "\n\n")[0]
 	runevent.SHA = commit.SHA
+	runevent.HasSkipCommand = provider.SkipCI(commit.RepoCommit.Message)
+
 	return nil
 }
 

pkg/provider/github/github.go

@@ -406,6 +406,7 @@ func (v *Provider) GetCommitInfo(ctx context.Context, runevent *info.Event) erro
 	runevent.SHAURL = commit.GetHTMLURL()
 	runevent.SHATitle = strings.Split(commit.GetMessage(), "\n\n")[0]
 	runevent.SHA = commit.GetSHA()
+	runevent.HasSkipCommand = provider.SkipCI(commit.GetMessage())
 
 	return nil
 }

pkg/provider/gitlab/gitlab.go

@@ -477,6 +477,7 @@ func (v *Provider) GetCommitInfo(_ context.Context, runevent *info.Event) error
 		runevent.SHA = branchinfo.ID
 		runevent.SHATitle = branchinfo.Title
 		runevent.SHAURL = branchinfo.WebURL
+		runevent.HasSkipCommand = provider.SkipCI(branchinfo.Message)
 	}
 
 	return nil

pkg/provider/provider.go

@@ -214,3 +214,22 @@ func GetCheckName(status StatusOpts, pacopts *info.PacOpts) string {
 func IsZeroSHA(sha string) bool {
 	return sha == "0000000000000000000000000000000000000000"
 }
+
+// These commands if present in the commit message will skip the CI.
+var skipCICommands = []string{
+	"[skip ci]",
+	"[ci skip]",
+	"[skip tkn]",
+	"[tkn skip]",
+}
+
+// Skip CI returns true if the given commit message contains any skip command.
+func SkipCI(commitMessage string) bool {
+	for _, command := range skipCICommands {
+		if strings.Contains(commitMessage, command) {
+			return true
+		}
+	}
+
+	return false
+}