Skip to content

Commit

Permalink
feat(tekton): support matching pruns via labels
Browse files Browse the repository at this point in the history 
Implement annotation-based PipelineRun to label matching functionality:

- Add `pipelinesascode.tekton.dev/on-label` annotation for label-based
  PipelineRun triggers
- Support label matching on GitHub, Gitea, and GitLab providers
- Implement immediate PipelineRun triggering when labels are added
- Enable re-triggering of PipelineRuns on commit updates with existing labels
- Provide access to Pull Request labels via `{{ labels }}` dynamic variable

Supported providers:
- GitHub
- Gitea
- GitLab

Limitations:
- Not supported on Bitbucket Cloud and Bitbucket Server

Signed-off-by: Chmouel Boudjnah <[email protected]>
  • Loading branch information
@chmouel
chmouel committed Dec 11, 2024
1 parent 7c9cfe1 commit 64d697e
Show file tree
Hide file tree
Showing 34 changed files with 517 additions and 96 deletions.
35 changes: 18 additions & 17 deletions docs/content/docs/guide/authoringprs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,23 +47,24 @@ getting tested. You usually use this with the
[git-clone](https://hub.tekton.dev/tekton/task/git-clone) task to be able to
checkout the code that is being tested.

| Variable | Description | Example | Example Output |
|---------------------|---------------------------------------------------------------------------------------------------|-------------------------------------|------------------------------|
| body | The full payload body (see [below](#using-the-body-and-headers-in-a-pipelines-as-code-parameter)) | `{{body.pull_request.user.email }}` | <[email protected]> |
| event_type | The event type (eg: `pull_request` or `push`) | `{{event_type}}` | pull_request (see the note for Gitops Comments [here]({{< relref "/docs/guide/gitops_commands.md#event-type-annotation-and-dynamic-variables" >}}) ) |
| git_auth_secret | The secret name auto generated with provider token to check out private repos. | `{{git_auth_secret}}` | pac-gitauth-xkxkx |
| headers | The request headers (see [below](#using-the-body-and-headers-in-a-pipelines-as-code-parameter)) | `{{headers['x-github-event']}}` | push |
| pull_request_number | The pull or merge request number, only defined when we are in a `pull_request` event type. | `{{pull_request_number}}` | 1 |
| repo_name | The repository name. | `{{repo_name}}` | pipelines-as-code |
| repo_owner | The repository owner. | `{{repo_owner}}` | openshift-pipelines |
| repo_url | The repository full URL. | `{{repo_url}}` | https:/github.com/repo/owner |
| revision | The commit full sha revision. | `{{revision}}` | 1234567890abcdef |
| sender | The sender username (or accountid on some providers) of the commit. | `{{sender}}` | johndoe |
| source_branch | The branch name where the event come from. | `{{source_branch}}` | main |
| source_url | The source repository URL from which the event come from (same as `repo_url` for push events). | `{{source_url}}` | https:/github.com/repo/owner |
| target_branch | The branch name on which the event targets (same as `source_branch` for push events). | `{{target_branch}}` | main |
| target_namespace | The target namespace where the Repository has matched and the PipelineRun will be created. | `{{target_namespace}}` | my-namespace |
| trigger_comment | The comment triggering the pipelinerun when using a [GitOps command]({{< relref "/docs/guide/running.md#gitops-command-on-pull-or-merge-request" >}}) (like `/test`, `/retest`) | `{{trigger_comment}}` | /merge-pr branch |
| Variable | Description | Example | Example Output |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
| body | The full payload body (see [below](#using-the-body-and-headers-in-a-pipelines-as-code-parameter)) | `{{body.pull_request.user.email }}` | <[email protected]> |
| event_type | The event type (eg: `pull_request` or `push`) | `{{event_type}}` | pull_request (see the note for Gitops Comments [here]({{< relref "/docs/guide/gitops_commands.md#event-type-annotation-and-dynamic-variables" >}}) ) |
| git_auth_secret | The secret name auto generated with provider token to check out private repos. | `{{git_auth_secret}}` | pac-gitauth-xkxkx |
| headers | The request headers (see [below](#using-the-body-and-headers-in-a-pipelines-as-code-parameter)) | `{{headers['x-github-event']}}` | push |
| pull_request_number | The pull or merge request number, only defined when we are in a `pull_request` event type. | `{{pull_request_number}}` | 1 |
| repo_name | The repository name. | `{{repo_name}}` | pipelines-as-code |
| repo_owner | The repository owner. | `{{repo_owner}}` | openshift-pipelines |
| repo_url | The repository full URL. | `{{repo_url}}` | https:/github.com/repo/owner |
| revision | The commit full sha revision. | `{{revision}}` | 1234567890abcdef |
| sender | The sender username (or accountid on some providers) of the commit. | `{{sender}}` | johndoe |
| source_branch | The branch name where the event come from. | `{{source_branch}}` | main |
| source_url | The source repository URL from which the event come from (same as `repo_url` for push events). | `{{source_url}}` | https:/github.com/repo/owner |
| target_branch | The branch name on which the event targets (same as `source_branch` for push events). | `{{target_branch}}` | main |
| target_namespace | The target namespace where the Repository has matched and the PipelineRun will be created. | `{{target_namespace}}` | my-namespace |
| trigger_comment | The comment triggering the pipelinerun when using a [GitOps command]({{< relref "/docs/guide/running.md#gitops-command-on-pull-or-merge-request" >}}) (like `/test`, `/retest`) | `{{trigger_comment}}` | /merge-pr branch |
| labels | The labels of the pull request separated by a newline | `{{labels}}` | bugs\nenhancement |

## Matching an event to a PipelineRun

Expand Down
41 changes: 39 additions & 2 deletions docs/content/docs/guide/matchingevents.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ and you have a `Pull Request` changing the files `.tekton/pipelinerun.yaml`,
`on-path-change-ignore` annotation will ignore the `***.md` and `***.yaml`
files.

## Matching a PipelineRun on a regexp in a comment
## Matching a PipelineRun on a Regexp in a comment

{{< tech_preview "Matching PipelineRun on regexp in comments" >}}

Expand Down Expand Up @@ -211,6 +211,43 @@ PipelineRun.

> *NOTE*: The `on-comment` annotation is only supported on GitHub, Gitea and GitLab providers

## Matching PipelineRun to a Pull Request labels

{{< tech_preview "Matching PipelineRun to a Pull-Request label" >}}

Using the annotation `pipelinesascode.tekton.dev/on-label`, you can match a
PipelineRun to a Pull Request label. For example, if you want to match the
PipelineRun `bugs` whenever a Pull Request has the label `bug` or `defect`, you
can use this annotation:

```yaml
metadata:
name: match-bugs-or-defect
annotations:
pipelinesascode.tekton.dev/on-label: [bug, defect]
```

- The `on-label` annotation respects the `pull_request` [Policy]({{< relref
"/docs/guide/policy" >}}) rules.
- This annotation is currently supported only on GitHub, Gitea, and GitLab
providers. Bitbucket Cloud and Bitbucket Server do not support adding labels
to Pull Requests.
- When you add a label to a Pull Request, the corresponding PipelineRun is
triggered immediately, and no other PipelineRun matching the same Pull Request
will be activated.
- If you update the Pull Request by sending a new commit, the PipelineRun
with a matching `on-label` annotation will be triggered again if the label is
still present.
- You can access the `Pull Request` labels with the [dynamic variable]({{< relref "/docs/guide/authoringprs#dynamic-variables" >}}) `{{ labels }}`.
The labels are separated by a Unix newline `\n`.
For example with a shell script you can do this to print them:

```bash
for i in $(echo -e "{{ labels }}");do
echo $i
done
```

## Advanced event matching using CEL

If you need to do some advanced matching, `Pipelines-as-Code` supports CEL
Expand Down Expand Up @@ -366,7 +403,7 @@ or close/open the pull request.

{{< /hint >}}

### Matching PipelineRun on request header
### Matching a PipelineRun to a request header

You can do some further filtering on the headers as passed by the Git provider
with the CEL variable `headers`.
Expand Down
1 change: 1 addition & 0 deletions pkg/apis/pipelinesascode/keys/keys.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ const (
OnComment = pipelinesascode.GroupName + "/on-comment"
OnTargetBranch = pipelinesascode.GroupName + "/on-target-branch"
OnPathChange = pipelinesascode.GroupName + "/on-path-change"
OnLabel = pipelinesascode.GroupName + "/on-label"
OnPathChangeIgnore = pipelinesascode.GroupName + "/on-path-change-ignore"
OnCelExpression = pipelinesascode.GroupName + "/on-cel-expression"
TargetNamespace = pipelinesascode.GroupName + "/target-namespace"
Expand Down
1 change: 1 addition & 0 deletions pkg/customparams/customparams_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@ func TestProcessTemplates(t *testing.T) {
"target_branch": "",
"target_namespace": "",
"trigger_comment": "",
"labels": "",
},
repository: &v1alpha1.Repository{
Spec: v1alpha1.RepositorySpec{},
Expand Down
2 changes: 2 additions & 0 deletions pkg/customparams/standard.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ func (p *CustomParams) makeStandardParamsFromEvent(ctx context.Context) (map[str
}
changedFiles := p.getChangedFiles(ctx)
triggerCommentAsSingleLine := strings.ReplaceAll(p.event.TriggerComment, "\n", "\\n")
pullRequestLabels := strings.Join(p.event.PullRequestLabel, "\\n")

return map[string]string{
"revision": p.event.SHA,
Expand All @@ -47,6 +48,7 @@ func (p *CustomParams) makeStandardParamsFromEvent(ctx context.Context) (map[str
"target_namespace": p.repo.GetNamespace(),
"event_type": opscomments.EventTypeBackwardCompat(p.eventEmitter, p.repo, p.event.EventType),
"trigger_comment": triggerCommentAsSingleLine,
"labels": pullRequestLabels,
}, map[string]interface{}{
"all": changedFiles.All,
"added": changedFiles.Added,
Expand Down
22 changes: 12 additions & 10 deletions pkg/customparams/standard_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,17 @@ import (

func TestMakeStandardParamsFromEvent(t *testing.T) {
event := &info.Event{
SHA: "1234567890",
Organization: "Org",
Repository: "Repo",
BaseBranch: "main",
HeadBranch: "foo",
EventType: "pull_request",
Sender: "SENDER",
URL: "https://paris.com",
HeadURL: "https://india.com",
TriggerComment: "/test me\nHelp me obiwan kenobi",
SHA: "1234567890",
Organization: "Org",
Repository: "Repo",
BaseBranch: "main",
HeadBranch: "foo",
EventType: "pull_request",
Sender: "SENDER",
URL: "https://paris.com",
HeadURL: "https://india.com",
TriggerComment: "/test me\nHelp me obiwan kenobi",
PullRequestLabel: []string{"bugs", "enhancements"},
}

result := map[string]string{
Expand All @@ -37,6 +38,7 @@ func TestMakeStandardParamsFromEvent(t *testing.T) {
"target_branch": "main",
"target_namespace": "myns",
"trigger_comment": "/test me\\nHelp me obiwan kenobi",
"labels": "bugs\\nenhancements",
}

repo := &v1alpha1.Repository{
Expand Down
25 changes: 23 additions & 2 deletions pkg/matcher/annotation_matcher.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,12 @@ func MatchPipelinerunByAnnotation(ctx context.Context, logger *zap.SugaredLogger
event.URL,
event.BaseBranch,
event.HeadBranch,
event.TriggerTarget)
event.TriggerTarget,
)

if len(event.PullRequestLabel) > 0 {
infomsg += fmt.Sprintf(", labels=%s", strings.Join(event.PullRequestLabel, "|"))
}

if event.EventType == triggertype.Incoming.String() {
infomsg = fmt.Sprintf("%s, target-pipelinerun=%s", infomsg, event.TargetPipelineRun)
Expand Down Expand Up @@ -248,10 +253,25 @@ func MatchPipelinerunByAnnotation(ctx context.Context, logger *zap.SugaredLogger
if !matched {
continue
}
logger.Infof("Matched pipelinerun with name: %s, annotation PathChange: %q", prName, key)
logger.Infof("matched PipelineRun with name: %s, annotation PathChange: %q", prName, key)
prMatch.Config["path-change"] = key
}

if key, ok := prun.GetObjectMeta().GetAnnotations()[keys.OnLabel]; ok {
matched, err := matchOnAnnotation(key, event.PullRequestLabel, false)
if err != nil {
return matchedPRs, err
}
if !matched {
continue
}
logger.Infof("matched PipelineRun with name: %s, annotation Label: %q", prName, key)
prMatch.Config["label"] = key
} else if event.EventType == string(triggertype.LabelUpdate) {
logger.Infof("label update event, PipelineRun %s does not have a on-label for any of those labels: %s", prName, strings.Join(event.PullRequestLabel, "|"))
continue
}

if key, ok := prun.GetObjectMeta().GetAnnotations()[keys.OnPathChangeIgnore]; ok {
changedFiles, err := vcx.GetFiles(ctx, event)
if err != nil {
Expand Down Expand Up @@ -326,6 +346,7 @@ func matchOnAnnotation(annotations string, eventType []string, branchMatching bo
if v == e {
gotit = v
}

if branchMatching && branchMatch(v, e) {
gotit = v
}
Expand Down
Loading

0 comments on commit 64d697e

Please sign in to comment.