feat: PR labels (#3002) (#3118)

Signed-off-by: Dominik Münch <[email protected]>

docs/docs/35-references/10-promotion-steps.md

@@ -1021,6 +1021,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
 

go.mod

@@ -122,6 +122,7 @@ require (
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
 	github.com/shopspring/decimal v1.4.0 // indirect
 	github.com/spf13/cast v1.7.0 // indirect
+	github.com/stretchr/objx v0.5.2 // indirect
 	github.com/valyala/bytebufferpool v1.0.0 // indirect
 	github.com/x448/float16 v0.8.4 // indirect
 	github.com/xeipuuv/gojsonpointer v0.0.0-20190905194746-02993c407bfb // indirect

internal/directives/git_pr_opener.go

@@ -218,6 +218,7 @@ func (g *gitPROpener) runPromotionStep(
 			Base:        cfg.TargetBranch,
 			Title:       title,
 			Description: description,
+			Labels:      cfg.Labels,
 		},
 	); err != nil {
 		return PromotionStepResult{Status: kargoapi.PromotionPhaseErrored},

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": [

internal/gitprovider/azure/azure.go

@@ -7,6 +7,7 @@ import (
 	"strings"
 
 	"github.com/microsoft/azure-devops-go-api/azuredevops/v7"
+	adocore "github.com/microsoft/azure-devops-go-api/azuredevops/v7/core"
 	adogit "github.com/microsoft/azure-devops-go-api/azuredevops/v7/git"
 	"k8s.io/utils/ptr"
 
@@ -94,6 +95,12 @@ func (p *provider) CreatePullRequest(
 		return nil, fmt.Errorf("error getting repository %q: %w", p.repo, err)
 	}
 	repoID := ptr.To(repository.Id.String())
+	labels := make([]adocore.WebApiTagDefinition, 0, len(opts.Labels))
+	for _, label := range opts.Labels {
+		labels = append(labels, adocore.WebApiTagDefinition{
+			Name: &label,
+		})
+	}
 	sourceRefName := ptr.To(fmt.Sprintf("refs/heads/%s", opts.Head))
 	targetRefName := ptr.To(fmt.Sprintf("refs/heads/%s", opts.Base))
 	adoPR, err := gitClient.CreatePullRequest(ctx, adogit.CreatePullRequestArgs{
@@ -102,6 +109,7 @@ func (p *provider) CreatePullRequest(
 		GitPullRequestToCreate: &adogit.GitPullRequest{
 			Title:         &opts.Title,
 			Description:   &opts.Description,
+			Labels:        &labels,
 			SourceRefName: sourceRefName,
 			TargetRefName: targetRefName,
 		},

internal/gitprovider/github/github.go

@@ -41,11 +41,42 @@ func init() {
 	gitprovider.Register(ProviderName, registration)
 }
 
+type githubClient interface {
+	CreatePullRequest(
+		ctx context.Context,
+		owner string,
+		repo string,
+		pull *github.NewPullRequest,
+	) (*github.PullRequest, *github.Response, error)
+
+	ListPullRequests(
+		ctx context.Context,
+		owner string,
+		repo string,
+		opts *github.PullRequestListOptions,
+	) ([]*github.PullRequest, *github.Response, error)
+
+	GetPullRequests(
+		ctx context.Context,
+		owner string,
+		repo string,
+		number int,
+	) (*github.PullRequest, *github.Response, error)
+
+	AddLabelsToIssue(
+		ctx context.Context,
+		owner string,
+		repo string,
+		number int,
+		labels []string,
+	) ([]*github.Label, *github.Response, error)
+}
+
 // provider is a GitHub implementation of gitprovider.Interface.
 type provider struct { // nolint: revive
 	owner  string
 	repo   string
-	client *github.Client
+	client githubClient
 }
 
 // NewProvider returns a GitHub-based implementation of gitprovider.Interface.
@@ -81,10 +112,51 @@ func NewProvider(
 	return &provider{
 		owner:  owner,
 		repo:   repo,
-		client: client,
+		client: &githubClientWrapper{client},
 	}, nil
 }
 
+type githubClientWrapper struct {
+	client *github.Client
+}
+
+func (g githubClientWrapper) CreatePullRequest(
+	ctx context.Context,
+	owner string,
+	repo string,
+	pull *github.NewPullRequest,
+) (*github.PullRequest, *github.Response, error) {
+	return g.client.PullRequests.Create(ctx, owner, repo, pull)
+}
+
+func (g githubClientWrapper) ListPullRequests(
+	ctx context.Context,
+	owner string,
+	repo string,
+	opts *github.PullRequestListOptions,
+) ([]*github.PullRequest, *github.Response, error) {
+	return g.client.PullRequests.List(ctx, owner, repo, opts)
+}
+
+func (g githubClientWrapper) GetPullRequests(
+	ctx context.Context,
+	owner string,
+	repo string,
+	number int,
+) (*github.PullRequest, *github.Response, error) {
+	return g.client.PullRequests.Get(ctx, owner, repo, number)
+}
+
+func (g githubClientWrapper) AddLabelsToIssue(
+	ctx context.Context,
+	owner string,
+	repo string,
+	number int,
+	labels []string,
+) ([]*github.Label, *github.Response, error) {
+	return g.client.Issues.AddLabelsToIssue(ctx, owner, repo, number, labels)
+}
+
 // CreatePullRequest implements gitprovider.Interface.
 func (p *provider) CreatePullRequest(
 	ctx context.Context,
@@ -93,7 +165,7 @@ func (p *provider) CreatePullRequest(
 	if opts == nil {
 		opts = &gitprovider.CreatePullRequestOpts{}
 	}
-	ghPR, _, err := p.client.PullRequests.Create(ctx,
+	ghPR, _, err := p.client.CreatePullRequest(ctx,
 		p.owner,
 		p.repo,
 		&github.NewPullRequest{
@@ -111,6 +183,17 @@ func (p *provider) CreatePullRequest(
 		return nil, fmt.Errorf("unexpected nil pull request")
 	}
 	pr := convertGithubPR(*ghPR)
+	if len(opts.Labels) > 0 {
+		_, _, err = p.client.AddLabelsToIssue(ctx,
+			p.owner,
+			p.repo,
+			int(pr.Number),
+			opts.Labels,
+		)
+	}
+	if err != nil {
+		return nil, err
+	}
 	return &pr, nil
 }
 
@@ -119,7 +202,7 @@ func (p *provider) GetPullRequest(
 	ctx context.Context,
 	id int64,
 ) (*gitprovider.PullRequest, error) {
-	ghPR, _, err := p.client.PullRequests.Get(ctx, p.owner, p.repo, int(id))
+	ghPR, _, err := p.client.GetPullRequests(ctx, p.owner, p.repo, int(id))
 	if err != nil {
 		return nil, err
 	}
@@ -160,7 +243,7 @@ func (p *provider) ListPullRequests(
 	}
 	prs := []gitprovider.PullRequest{}
 	for {
-		ghPRs, res, err := p.client.PullRequests.List(ctx, p.owner, p.repo, &listOpts)
+		ghPRs, res, err := p.client.ListPullRequests(ctx, p.owner, p.repo, &listOpts)
 		if err != nil {
 			return nil, err
 		}