ticket url pattern (#34)

Author: slack-jallen

commands/command_new.go

@@ -59,6 +59,9 @@ func createNewCommand() *cobra.Command {
 			"                                the prefix of the ticket number\n" +
 			"   FeatureFlag                  Value passed to feature-flag flag\n" +
 			"   TicketNumber                 Jira ticket as parsed from the commit summary\n" +
+			"   TicketUrlPattern             URL for the ticket, with {TicketNumber}\n" +
+			"                                replaced by the actual ticket number.\n" +
+			"                                Configured via config.yaml or --config.\n" +
 			"   Username                     Name as parsed from git config email.\n" +
 			"   UsernameCleaned              Username with dots (.) converted to dashes (-).\n",
 		Args: cobra.MaximumNArgs(1),
@@ -88,8 +91,16 @@ func createNewCommand() *cobra.Command {
 		if *baseBranch == "" {
 			*baseBranch = util.GetMainBranchOrDie()
 		}
+		ticketUrlPattern := userConfig.TicketUrlPattern
+		if ticketUrlPattern == "" && templates.TemplateUsesTicketUrlPattern() {
+			ticketUrlPattern = interactive.PromptForStringOrDie(
+				"Ticket URL pattern (use {TicketNumber} as placeholder):",
+				nil,
+			)
+			util.SaveTicketUrlPattern(ticketUrlPattern)
+		}
 		selectedReviewers, markReady := promptForReviewers(len(args) == 0 && *draft && *reviewers == "", userConfig, *merge)
-		createNewPr(*draft, *featureFlag, *baseBranch, targetCommits[0])
+		createNewPr(*draft, *featureFlag, ticketUrlPattern, *baseBranch, targetCommits[0])
 		maybeAddReviewers(*reviewers, selectedReviewers, markReady, targetCommits, AddReviewersOptions{
 			WhenChecksPass: true,
 			Silent:         *silent,
@@ -103,11 +114,11 @@ func createNewCommand() *cobra.Command {
 }
 
 // Creates a new pull request via Github CLI.
-func createNewPr(draft bool, featureFlag string, baseBranch string, gitLog templates.GitLog) {
+func createNewPr(draft bool, featureFlag string, ticketUrlPattern string, baseBranch string, gitLog templates.GitLog) {
 	templates.RequireCommitOnMain(gitLog.Commit)
 	util.WithStashAndRollback("sd new "+gitLog.Commit+" "+gitLog.Subject, func(rollbackManager *util.GitRollbackManager) {
 		createBranchAndCherryPick(rollbackManager, baseBranch, gitLog)
-		pushAndCreateGhPr(draft, featureFlag, baseBranch, gitLog)
+		pushAndCreateGhPr(draft, featureFlag, ticketUrlPattern, baseBranch, gitLog)
 		rollbackManager.Clear()
 		openPrAndSwitchBack(gitLog)
 	})
@@ -129,11 +140,11 @@ func createBranchAndCherryPick(rollbackManager *util.GitRollbackManager, baseBra
 	util.ExecuteOrDie(util.ExecuteOptions{}, "git", "cherry-pick", gitLog.Commit)
 }
 
-func pushAndCreateGhPr(draft bool, featureFlag string, baseBranch string, gitLog templates.GitLog) {
+func pushAndCreateGhPr(draft bool, featureFlag string, ticketUrlPattern string, baseBranch string, gitLog templates.GitLog) {
 	slog.Info("Pushing to remote")
 	// -u is required because in newer versions of Github CLI the upstream must be set.
 	util.ExecuteOrDie(util.ExecuteOptions{}, "git", "-c", "push.default=current", "push", "--force-with-lease", "-u")
-	prText := templates.GetPullRequestText(gitLog.Commit, featureFlag)
+	prText := templates.GetPullRequestText(gitLog.Commit, featureFlag, ticketUrlPattern)
 	slog.Info("Creating PR via gh")
 	createPrOutput := createPr(prText, baseBranch, draft)
 	slog.Info(fmt.Sprint("Created PR ", createPrOutput))

commands/parse_arguments.go

@@ -82,11 +82,14 @@ func buildRootCommand() *cobra.Command {
 			"~/.gh-stacked-diff/config.yaml. Supported keys:\n"+
 			"   promptForReview=never|promptY|promptN (default: promptN)\n"+
 			"   pollInterval=<duration> (default: 30s, e.g. 1m, 10s)\n"+
+			"   ticketUrlPattern=<url> URL pattern for tickets, e.g.\n"+
+			"                          https://jira.example.com/browse/{TicketNumber}\n"+
 			"Can be specified multiple times for different keys.\n"+
 			"\n"+
 			"Equivalent config.yaml:\n"+
 			"   promptForReview: promptY\n"+
-			"   pollInterval: 1m")
+			"   pollInterval: 1m\n"+
+			"   ticketUrlPattern: https://jira.example.com/browse/{TicketNumber}")
 	rootCmd.PersistentFlags().Lookup("config").DefValue = ""
 
 	rootCmd.PersistentPreRun = func(cmd *cobra.Command, args []string) {

commands/test_parse_arguments.go

@@ -87,6 +87,13 @@ func getTestConfigHome() string {
 	configHome := filepath.Join(parentDir, ".gh-stacked-diff")
 	// nolint:errcheck
 	os.Mkdir(configHome, os.ModePerm)
+	// Write a default config.yaml so that tests don't trigger interactive
+	// prompts for ticketUrlPattern.
+	configFile := filepath.Join(configHome, "config.yaml")
+	if _, statErr := os.Stat(configFile); os.IsNotExist(statErr) {
+		// nolint:errcheck
+		os.WriteFile(configFile, []byte("ticketUrlPattern: https://example.com/browse/{TicketNumber}\n"), 0644)
+	}
 	return configHome
 }
 

commands/user_config_test.go

@@ -73,3 +73,26 @@ func TestNewUserConfig_InvalidPollInterval(t *testing.T) {
 		util.NewUserConfig(util.YamlConfig{}, map[string]string{"pollInterval": "notaduration"})
 	})
 }
+
+func TestNewUserConfig_TicketUrlPatternDefault(t *testing.T) {
+	config := util.NewUserConfig(util.YamlConfig{}, nil)
+	assert.Equal(t, "", config.TicketUrlPattern)
+}
+
+func TestNewUserConfig_TicketUrlPatternFromFlag(t *testing.T) {
+	config := util.NewUserConfig(util.YamlConfig{}, map[string]string{"ticketUrlPattern": "https://jira.example.com/browse/{TicketNumber}"})
+	assert.Equal(t, "https://jira.example.com/browse/{TicketNumber}", config.TicketUrlPattern)
+}
+
+func TestNewUserConfig_TicketUrlPatternFromFile(t *testing.T) {
+	config := util.NewUserConfig(util.YamlConfig{TicketUrlPattern: "https://jira.example.com/browse/{TicketNumber}"}, nil)
+	assert.Equal(t, "https://jira.example.com/browse/{TicketNumber}", config.TicketUrlPattern)
+}
+
+func TestNewUserConfig_TicketUrlPatternFlagOverridesFile(t *testing.T) {
+	config := util.NewUserConfig(
+		util.YamlConfig{TicketUrlPattern: "https://file.example.com/{TicketNumber}"},
+		map[string]string{"ticketUrlPattern": "https://flag.example.com/{TicketNumber}"},
+	)
+	assert.Equal(t, "https://flag.example.com/{TicketNumber}", config.TicketUrlPattern)
+}

templates/config/pr_description.template

@@ -24,6 +24,6 @@
 
 -->
 
-#### Ticket: [{{.TicketNumber}}](https://jira.slackhq.com/browse/{{.TicketNumber}})
+#### Ticket: [{{.TicketNumber}}]({{.TicketUrlPattern}})
 
 #### Feature flag(s): `{{.FeatureFlag}}`

templates/templates.go

@@ -5,6 +5,7 @@ import (
 	_ "embed"
 	"fmt"
 	"log/slog"
+	"os"
 	"regexp"
 	"strconv"
 	"strings"
@@ -34,6 +35,7 @@ type branchTemplateData struct {
 
 type templateData struct {
 	TicketNumber               string
+	TicketUrlPattern           string
 	Username                   string
 	CommitBody                 string
 	CommitSummary              string
@@ -157,8 +159,8 @@ func truncateString(str string, maxBytes int) string {
 	return str
 }
 
-func GetPullRequestText(commitHash string, featureFlag string) PullRequestText {
-	data := getPullRequestTemplateData(commitHash, featureFlag)
+func GetPullRequestText(commitHash string, featureFlag string, ticketUrlPattern string) PullRequestText {
+	data := getPullRequestTemplateData(commitHash, featureFlag, ticketUrlPattern)
 	title := RunTemplate("pr-title.template", prTitleTemplateText, data)
 	description := RunTemplate("pr-description.template", prDescriptionTemplateText, data)
 	return PullRequestText{Description: description, Title: title}
@@ -186,17 +188,20 @@ func RunTemplate(configFilename string, defaultTemplateText string, data any) st
 	return output.String()
 }
 
-func getPullRequestTemplateData(commitHash string, featureFlag string) templateData {
+func getPullRequestTemplateData(commitHash string, featureFlag string, ticketUrlPattern string) templateData {
 	commitSummary := util.ExecuteOrDieTrimmed(util.ExecuteOptions{}, "git", "--no-pager", "show", "--no-patch", "--format=%s", commitHash)
 	commitBody := util.ExecuteOrDieTrimmed(util.ExecuteOptions{}, "git", "--no-pager", "show", "--no-patch", "--format=%b", commitHash)
 	commentLineRegex := regexp.MustCompile("(?m)^#.*$")
 	commitBody = commentLineRegex.ReplaceAllString(commitBody, "")
 	commitSummaryCleaned := util.ExecuteOrDieTrimmed(util.ExecuteOptions{}, "git", "show", "--no-patch", "--format=%f", commitHash)
 	expression := regexp.MustCompile(`^(\S+-[[:digit:]]+ )?(.*)`)
 	summaryMatches := expression.FindStringSubmatch(commitSummary)
+	ticketNumber := strings.TrimSpace(summaryMatches[1])
+	resolvedTicketUrl := strings.ReplaceAll(ticketUrlPattern, "{TicketNumber}", ticketNumber)
 	return templateData{
 		Username:                   util.GetUsername(),
-		TicketNumber:               strings.TrimSpace(summaryMatches[1]),
+		TicketNumber:               ticketNumber,
+		TicketUrlPattern:           resolvedTicketUrl,
 		CommitBody:                 commitBody,
 		CommitSummary:              commitSummary,
 		CommitSummaryWithoutTicket: summaryMatches[2],
@@ -205,6 +210,25 @@ func getPullRequestTemplateData(commitHash string, featureFlag string) templateD
 	}
 }
 
+// TemplateUsesTicketUrlPattern returns true if the PR description or title
+// template references the TicketUrlPattern variable.
+func TemplateUsesTicketUrlPattern() bool {
+	return templateTextContains("pr-description.template", prDescriptionTemplateText, "TicketUrlPattern") ||
+		templateTextContains("pr-title.template", prTitleTemplateText, "TicketUrlPattern")
+}
+
+func templateTextContains(configFilename string, defaultText string, search string) bool {
+	configFile := util.GetConfigFile(configFilename)
+	if configFile != "" {
+		data, err := os.ReadFile(configFile)
+		if err != nil {
+			panic(fmt.Sprint("Could not read ", configFile, ": ", err))
+		}
+		return strings.Contains(string(data), search)
+	}
+	return strings.Contains(defaultText, search)
+}
+
 func getBranchTemplateData(sanitizedSummary string) branchTemplateData {
 	// Dots are not allowed in branch names of some Github configurations.
 	username := strings.ReplaceAll(util.GetUsername(), ".", "-")

util/user_config.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"log/slog"
 	"os"
+	"path/filepath"
 	"time"
 
 	"gopkg.in/yaml.v3"
@@ -31,13 +32,15 @@ func (t PromptForReviewType) IsValid() bool {
 
 // UserConfig holds runtime configuration from config file and --config flag key=value entries.
 type UserConfig struct {
-	PromptForReview PromptForReviewType
-	PollInterval    time.Duration
+	PromptForReview  PromptForReviewType
+	PollInterval     time.Duration
+	TicketUrlPattern string
 }
 
 type YamlConfig struct {
-	PromptForReview PromptForReviewType `yaml:"promptForReview"`
-	PollInterval    string              `yaml:"pollInterval"`
+	PromptForReview  PromptForReviewType `yaml:"promptForReview,omitempty"`
+	PollInterval     string              `yaml:"pollInterval,omitempty"`
+	TicketUrlPattern string              `yaml:"ticketUrlPattern,omitempty"`
 }
 
 // LoadUserConfigFile reads config.yaml from ConfigHome if it exists.
@@ -78,6 +81,9 @@ func NewUserConfig(fileConfig YamlConfig, flagValues map[string]string) UserConf
 		d, _ := time.ParseDuration(fileConfig.PollInterval)
 		config.PollInterval = d
 	}
+	if fileConfig.TicketUrlPattern != "" {
+		config.TicketUrlPattern = fileConfig.TicketUrlPattern
+	}
 	for key, value := range flagValues {
 		switch key {
 		case "promptForReview":
@@ -92,9 +98,27 @@ func NewUserConfig(fileConfig YamlConfig, flagValues map[string]string) UserConf
 				panic("invalid pollInterval value: " + value)
 			}
 			config.PollInterval = d
+		case "ticketUrlPattern":
+			config.TicketUrlPattern = value
 		default:
 			panic("unknown --config key: " + key)
 		}
 	}
 	return config
 }
+
+// SaveTicketUrlPattern saves the ticketUrlPattern value to the config file,
+// preserving any existing config values.
+func SaveTicketUrlPattern(pattern string) {
+	fileConfig := LoadUserConfigFile()
+	fileConfig.TicketUrlPattern = pattern
+	configPath := filepath.Join(GetAppConfig().ConfigHome, "config.yaml")
+	data, err := yaml.Marshal(fileConfig)
+	if err != nil {
+		panic(fmt.Sprint("Could not marshal config: ", err))
+	}
+	if err := os.WriteFile(configPath, data, 0644); err != nil {
+		panic(fmt.Sprint("Could not write config file: ", err))
+	}
+	slog.Info(fmt.Sprint("Saved ticketUrlPattern to ", configPath))
+}