Add shortcut link to description

Author: vanilevsky

README.md

@@ -54,7 +54,7 @@ Replace `<GITHUB_TOKEN>`, `<OPENAI_TOKEN>`, `<OWNER>`, `<REPO>`, and `<PR_NUMBER
 ### Description Command
 
 The usage for the `description` command is similar to the `review` command. Replace `review` with `description` in the command above and execute.
-Only difference is that `description` command has extra option `--jira-url` which is used to generate Jira links in the description.
+The only difference is that the `description` command has extra options, `--jira-url` and `--shortcut-url`, which are used to generate Jira or Shortcut links in the description, accordingly.
 
 ## GitHub Action
 

cmd/description/main.go

@@ -3,17 +3,18 @@ package main
 import (
 	"context"
 	"fmt"
+	"github.com/ravilushqa/gpt-pullrequest-updater/description"
+	oAIClient "github.com/ravilushqa/gpt-pullrequest-updater/openai"
+	"github.com/ravilushqa/gpt-pullrequest-updater/shortcut"
 	"os"
 	"os/signal"
 	"syscall"
 
 	"github.com/google/go-github/v51/github"
 	"github.com/jessevdk/go-flags"
 
-	"github.com/ravilushqa/gpt-pullrequest-updater/description"
 	ghClient "github.com/ravilushqa/gpt-pullrequest-updater/github"
 	"github.com/ravilushqa/gpt-pullrequest-updater/jira"
-	oAIClient "github.com/ravilushqa/gpt-pullrequest-updater/openai"
 )
 
 var opts struct {
@@ -25,7 +26,7 @@ var opts struct {
 	OpenAIModel     string `long:"openai-model" env:"OPENAI_MODEL" description:"OpenAI model" default:"gpt-3.5-turbo"`
 	Test            bool   `long:"test" env:"TEST" description:"Test mode"`
 	JiraURL         string `long:"jira-url" env:"JIRA_URL" description:"Jira URL. Example: https://jira.atlassian.com"`
-	ShortcutBaseURL string `long:"shortcut-url" env:"SHORTCUT_URL" description:"Shortcut URL. Example: https://app.shortcut.com/foo/"`
+	ShortcutBaseUrl string `long:"shortcut-url" env:"SHORTCUT_URL" description:"Shortcut URL. Example: https://app.shortcut.com/foo/"`
 }
 
 func main() {
@@ -73,6 +74,13 @@ func run(ctx context.Context) error {
 		}
 	}
 
+	if opts.ShortcutBaseUrl != "" {
+		shortcutContent := buildShortcutContent(opts.ShortcutBaseUrl, pr)
+		if shortcutContent != "" {
+			completion = fmt.Sprintf("%s\n\n%s", shortcutContent, completion)
+		}
+	}
+
 	if opts.Test {
 		return nil
 	}
@@ -86,3 +94,21 @@ func run(ctx context.Context) error {
 
 	return nil
 }
+
+func buildShortcutContent(shortcutBaseUrl string, pr *github.PullRequest) string {
+	fmt.Println("Adding Shortcut ticket")
+
+	id, err := shortcut.ExtractShortcutStoryId(*pr.Title)
+
+	if err != nil {
+		// Extracting from the branch name
+		id, err = shortcut.ExtractShortcutStoryId(*pr.Head.Ref)
+	}
+
+	if err != nil {
+		fmt.Printf("There is no Shortcut story ID: %v \n", err)
+		return ""
+	}
+
+	return fmt.Sprintf("### Shortcut story: [%s](%s)", id, shortcut.GenerateShortcutStoryUrl(shortcutBaseUrl, id))
+}

shortcut/shortcut.go

@@ -0,0 +1,29 @@
+package shortcut
+
+import (
+	"fmt"
+	"regexp"
+)
+
+const storyUrlFormat = "%s/story/%s"
+
+func ExtractShortcutStoryId(title string) (string, error) {
+
+	// This regular expression pattern matches a Shortcut story ID (e.g. sc-12345).
+	pattern := `sc-([\d]+)`
+	re, err := regexp.Compile(pattern)
+	if err != nil {
+		return "", fmt.Errorf("error compiling regex: %w", err)
+	}
+
+	matches := re.FindStringSubmatch(title)
+	if len(matches) < 2 {
+		return "", fmt.Errorf("no Shortcut story ID found in the input string")
+	}
+
+	return matches[1], nil
+}
+
+func GenerateShortcutStoryUrl(shortcutBaseUrl, ticketId string) string {
+	return fmt.Sprintf(storyUrlFormat, shortcutBaseUrl, ticketId)
+}