Merge branch 'main' into dependabot/go_modules/github.com/go-git/go-git/v5-5.13.0

Author: blaqbern

.pre-commit-config.yaml

@@ -10,10 +10,11 @@ repos:
     language: golang
     pass_filenames: false
 
-- repo: https://github.com/dnephin/pre-commit-golang
-  rev: v0.3.3
-  hooks:
-    - id: go-unit-tests
+# Run as part of GHA workflow
+# - repo: https://github.com/dnephin/pre-commit-golang
+#   rev: v0.3.3
+#   hooks:
+#     - id: go-unit-tests
 
 - repo: local
   hooks:

.secrets.example.env

@@ -1,4 +1,5 @@
 # Save as .secrets for testing with nektos/act
 
 LD_ACCESS_TOKEN= # LaunchDarkly access token
+LD_ACCESS_TOKEN_WRITER= # LaunchDarkly access token (both are used for local runs with act)
 GITHUB_TOKEN= # GitHub PAT with repo access

CHANGELOG.md

@@ -6,6 +6,24 @@
 
 ### Fixed
 
+## 2.1.0
+
+### Added
+
+- Add support for enterprise hosted github instances [More info](https://github.com/launchdarkly/find-code-references-in-pull-request/issues/102)
+
+### Changed
+
+### Fixed
+
+ - Potential null pointer error when creating flag links
+
+## 2.0.2
+
+### Changed
+
+- Update dependencies
+
 ## 2.0.1
 
 ### Changed

DEVELOPMENT.md

@@ -9,9 +9,10 @@
 ## Testing locally
 
 Use [nektos/act](https://github.com/nektos/act) to run actions locally.
+NB: You'll want to use the `large` runner in order to have access to all commands needed for testing.
 
 ```
-act
+act -e testdata/act/pull-request.json
 ```
 
 _Read more: [Example commands](https://github.com/nektos/act#example-commands)_

comments/comments.go

@@ -14,7 +14,8 @@ import (
 
 	sprig "github.com/Masterminds/sprig/v3"
 
-	"github.com/google/go-github/github"
+	"github.com/google/go-github/v68/github"
+
 	ldapi "github.com/launchdarkly/api-client-go/v15"
 	lcr "github.com/launchdarkly/find-code-references-in-pull-request/config"
 	gha "github.com/launchdarkly/find-code-references-in-pull-request/internal/github_actions"

config/config.go

@@ -7,7 +7,8 @@ import (
 	"strconv"
 	"strings"
 
-	"github.com/google/go-github/github"
+	"github.com/google/go-github/v68/github"
+
 	"golang.org/x/oauth2"
 
 	gha "github.com/launchdarkly/find-code-references-in-pull-request/internal/github_actions"
@@ -97,14 +98,27 @@ func ValidateInputandParse(ctx context.Context) (*Config, error) {
 		config.CreateFlagLinks = createFlagLinks
 	}
 
-	config.GHClient = getGithubClient(ctx)
+	client, err := getGithubClient(ctx)
+	if err != nil {
+		return nil, err
+	}
+	config.GHClient = client
+
 	return &config, nil
 }
 
-func getGithubClient(ctx context.Context) *github.Client {
+func getGithubClient(ctx context.Context) (*github.Client, error) {
 	ts := oauth2.StaticTokenSource(
 		&oauth2.Token{AccessToken: os.Getenv("GITHUB_TOKEN")},
 	)
 	tc := oauth2.NewClient(ctx, ts)
-	return github.NewClient(tc)
+	gc := github.NewClient(tc)
+
+	host := os.Getenv("GITHUB_SERVER_URL")
+	if host != "https://github.com" && host != "" {
+		gha.Log("Using GitHub Enterprise host. baseUrl: %s, uploadUrl: %s", host+"/api/v3/", host+"/api/uploads/")
+		return gc.WithEnterpriseURLs(host+"/api/v3/", host+"/api/uploads/")
+	}
+
+	return gc, nil
 }

go.mod

@@ -1,12 +1,12 @@
 module github.com/launchdarkly/find-code-references-in-pull-request
 
-go 1.22
-toolchain go1.22.5
+go 1.22.0
+
+toolchain go1.22.7
 
 require (
 	github.com/Masterminds/sprig/v3 v3.3.0
-	github.com/google/go-github v17.0.0+incompatible
-	github.com/google/go-querystring v1.0.0 // indirect
+	github.com/google/go-querystring v1.1.0 // indirect
 	github.com/monochromegane/go-gitignore v0.0.0-20200626010858-205db1a8cc00
 	github.com/sourcegraph/go-diff v0.6.1
 	github.com/spf13/viper v1.19.0
@@ -15,6 +15,7 @@ require (
 )
 
 require (
+	github.com/google/go-github/v68 v68.0.0
 	github.com/jstemmer/go-junit-report/v2 v2.1.0
 	github.com/kyoh86/richgo v0.3.12
 	github.com/launchdarkly/ld-find-code-refs/v2 v2.13.0

go.sum

@@ -107,8 +107,10 @@ github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
 github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/google/go-github v17.0.0+incompatible h1:N0LgJ1j65A7kfXrZnUDaYCs/Sf4rEjNlfyDHW9dolSY=
 github.com/google/go-github v17.0.0+incompatible/go.mod h1:zLgOLi98H3fifZn+44m+umXrS52loVEgC2AApnigrVQ=
-github.com/google/go-querystring v1.0.0 h1:Xkwi/a1rcvNg1PPYe5vI8GbeBY/jrVuDX5ASuANWTrk=
-github.com/google/go-querystring v1.0.0/go.mod h1:odCYkC5MyYFN7vkCjXpyrEuKhc/BUO6wN/zVPAxq5ck=
+github.com/google/go-github/v68 v68.0.0 h1:ZW57zeNZiXTdQ16qrDiZ0k6XucrxZ2CGmoTvcCyQG6s=
+github.com/google/go-github/v68 v68.0.0/go.mod h1:K9HAUBovM2sLwM408A18h+wd9vqdLOEqTUCbnRIcx68=
+github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8=
+github.com/google/go-querystring v1.1.0/go.mod h1:Kcdr2DB4koayq7X8pmAG4sNG59So17icRSOU623lUBU=
 github.com/google/martian v2.1.0+incompatible/go.mod h1:9I4somxYTbIHy5NJKHRl3wXiIaQGbYVAs8BPL6v8lEs=
 github.com/google/martian/v3 v3.0.0/go.mod h1:y5Zk1BBys9G+gd6Jrk0W3cC1+ELVxBWuIGO+w/tUAp0=
 github.com/google/pprof v0.0.0-20181206194817-3ea8567a2e57/go.mod h1:zfwlbNMJ+OItoe0UupaVj+oy1omPYYDuagoSzA8v9mc=

internal/ldclient/flag_links.go

@@ -9,10 +9,12 @@ import (
 	"strconv"
 	"strings"
 
-	"github.com/google/go-github/github"
+	"github.com/google/go-github/v68/github"
+
 	ldapi "github.com/launchdarkly/api-client-go/v15"
 	lcr "github.com/launchdarkly/find-code-references-in-pull-request/config"
 	gha "github.com/launchdarkly/find-code-references-in-pull-request/internal/github_actions"
+	"github.com/launchdarkly/find-code-references-in-pull-request/internal/utils"
 	"github.com/launchdarkly/find-code-references-in-pull-request/internal/version"
 
 	flags "github.com/launchdarkly/find-code-references-in-pull-request/internal/references"
@@ -100,23 +102,24 @@ func makeFlagLinkRep(event *github.PullRequestEvent, flagKey, message string) *l
 		return nil
 	}
 
+	authorLogin := utils.SafeString(pr.User.Login)
 	metadata := map[string]string{
 		"message":   message,
 		"prNumber":  strconv.Itoa(*pr.Number),
-		"prTitle":   *pr.Title,
-		"prBody":    *pr.Body,
-		"state":     *pr.State,
-		"avatarUrl": *pr.User.AvatarURL,
-		"repoName":  *event.Repo.FullName,
-		"repoUrl":   *event.Repo.HTMLURL,
+		"prTitle":   utils.SafeString(pr.Title),
+		"prBody":    utils.SafeString(pr.Body),
+		"state":     utils.SafeString(pr.State),
+		"avatarUrl": utils.SafeString(pr.User.AvatarURL),
+		"repoName":  utils.SafeString(event.Repo.FullName),
+		"repoUrl":   utils.SafeString(event.Repo.HTMLURL),
 	}
 
 	if pr.User.Name != nil {
-		metadata["authorName"] = *pr.User.Name
-		metadata["authorDisplayName"] = *pr.User.Name
+		metadata["authorName"] = utils.SafeString(pr.User.Name)
+		metadata["authorDisplayName"] = utils.SafeString(pr.User.Name)
 	} else {
-		metadata["authorDisplayName"] = *pr.User.Login
-		metadata["authorLogin"] = *pr.User.Login
+		metadata["authorDisplayName"] = authorLogin
+		metadata["authorLogin"] = authorLogin
 	}
 
 	var timestamp *int64
@@ -130,25 +133,30 @@ func makeFlagLinkRep(event *github.PullRequestEvent, flagKey, message string) *l
 	// key must be unique
 	key := fmt.Sprintf("github-pr-%s-%s", id, flagKey)
 
+	description := utils.SafeString(pr.Body)
+	// Flag links require a description
+	if description == "" {
+		description = "Empty PR Body"
+	}
 	return &ldapi.FlagLinkPost{
 		DeepLink:       pr.HTMLURL,
 		Key:            &key,
 		IntegrationKey: &integration,
 		Timestamp:      timestamp,
 		Title:          getLinkTitle(event),
-		Description:    pr.Body,
+		Description:    &description,
 		Metadata:       &metadata,
 	}
 }
 
 func getLinkTitle(event *github.PullRequestEvent) *string {
 	builder := new(strings.Builder)
-	builder.WriteString(fmt.Sprintf("[%s]", *event.Repo.FullName))
+	builder.WriteString(fmt.Sprintf("[%s]", utils.SafeString(event.Repo.FullName)))
 
 	pr := event.PullRequest
 	if pr.Title != nil {
 		builder.WriteString(" ")
-		builder.WriteString(*pr.Title)
+		builder.WriteString(utils.SafeString(pr.Title))
 		if pr.Number != nil {
 			builder.WriteString(fmt.Sprintf(" (#%d)", *pr.Number))
 		}

internal/utils/utils.go

@@ -14,3 +14,10 @@ func Dedupe(s []string) []string {
 	}
 	return ret
 }
+
+func SafeString(s *string) string {
+	if s != nil {
+		return *s
+	}
+	return ""
+}