feat: PR labels (#3002)

Signed-off-by: Dominik Münch <[email protected]>
akuity · Dec 10, 2024 · 22bd83c · 22bd83c
1 parent aecc74f
commit 22bd83c
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 0 deletions.
diff --git a/docs/docs/35-references/10-promotion-steps.md b/docs/docs/35-references/10-promotion-steps.md
@@ -1003,6 +1003,7 @@ requests.
 | `targetBranch` | `string` | N | The branch to which the changes should be merged. |
 | `createTargetBranch` | `boolean` | N | Indicates whether a new, empty orphaned branch should be created and pushed to the remote if the target branch does not already exist there. Default is `false`. |
 | `title` | `string` | N | The title for the pull request. Kargo generates a title based on the commit messages if it is not explicitly specified. |
+| `labels` | `[]string` | N | Labels to add to the pull request. |
 
 #### `git-open-pr`  Example
 

diff --git a/internal/directives/git_pr_opener.go b/internal/directives/git_pr_opener.go
@@ -217,6 +217,7 @@ func (g *gitPROpener) runPromotionStep(
 			Base:        cfg.TargetBranch,
 			Title:       title,
 			Description: description,
+			Labels:      cfg.Labels,
 		},
 	); err != nil {
 		return PromotionStepResult{Status: kargoapi.PromotionPhaseErrored},

diff --git a/internal/directives/schemas/git-open-pr-config.json b/internal/directives/schemas/git-open-pr-config.json
@@ -43,6 +43,15 @@
       "type": "string",
       "description": "The title for the pull request. Kargo generates a title based on the commit messages if it is not explicitly specified.",
       "minLength": 1
+    },
+    "labels": {
+      "type": "array",
+      "description": "Labels to add to the pull request.",
+      "items": {
+        "type": "string",
+        "description": "A pull request label",
+        "minLength": 1
+      }
     }
   },
   "oneOf": [

diff --git a/internal/directives/zz_config_types.go b/internal/directives/zz_config_types.go
diff --git a/internal/gitprovider/github/github.go b/internal/gitprovider/github/github.go
@@ -111,6 +111,17 @@ func (p *provider) CreatePullRequest(
 		return nil, fmt.Errorf("unexpected nil pull request")
 	}
 	pr := convertGithubPR(*ghPR)
+	if len(opts.Labels) > 0 {
+		_, _, err = p.client.Issues.AddLabelsToIssue(ctx,
+			p.owner,
+			p.repo,
+			int(pr.Number),
+			opts.Labels,
+		)
+	}
+	if err != nil {
+		return nil, err
+	}
 	return &pr, nil
 }
 

diff --git a/internal/gitprovider/gitlab/gitlab.go b/internal/gitprovider/gitlab/gitlab.go
@@ -119,6 +119,7 @@ func (p *provider) CreatePullRequest(
 	glMR, _, err := p.client.CreateMergeRequest(p.projectName, &gitlab.CreateMergeRequestOptions{
 		Title:              &opts.Title,
 		Description:        &opts.Description,
+		Labels:             (*gitlab.LabelOptions)(&opts.Labels),
 		SourceBranch:       &opts.Head,
 		TargetBranch:       &opts.Base,
 		RemoveSourceBranch: gitlab.Ptr(true),

diff --git a/internal/gitprovider/gitprovider.go b/internal/gitprovider/gitprovider.go
@@ -64,6 +64,8 @@ type CreatePullRequestOpts struct {
 	Head string
 	// Base is the name of the target branch.
 	Base string
+	// Labels is an array of strings that should be added as labels to the pull request.
+	Labels []string
 }
 
 // ListPullRequestOptions encapsulates the options used when listing pull

diff --git a/ui/src/gen/directives/git-open-pr-config.json b/ui/src/gen/directives/git-open-pr-config.json
@@ -45,6 +45,15 @@
    "type": "string",
    "description": "The title for the pull request. Kargo generates a title based on the commit messages if it is not explicitly specified.",
    "minLength": 1
+  },
+  "labels": {
+   "type": "array",
+   "description": "Labels to add to the pull request.",
+   "items": {
+    "type": "string",
+    "description": "A pull request label",
+    "minLength": 1
+   }
   }
  }
 }