add links to downstack prs in body

Author: skarim

cmd/push.go

@@ -120,7 +120,7 @@ func runPush(cfg *config.Config, opts *pushOptions) error {
 					title = input
 				}
 			}
-			body := fmt.Sprintf("Part %d of stack.\n\nBase: `%s`", i+1, baseBranch)
+			body := generatePRBody(s, b.Branch)
 
 			newPR, createErr := client.CreatePR(baseBranch, b.Branch, title, body, opts.draft)
 			if createErr != nil {
@@ -199,6 +199,47 @@ func defaultPRTitle(base, head string) string {
 	return humanize(head)
 }
 
+// generatePRBody builds a rich PR description showing the downstack branches,
+// the current branch, and a footer with links to the CLI and feedback form.
+func generatePRBody(s *stack.Stack, currentBranch string) string {
+	var lines []string
+
+	// Current branch entry (always first)
+	lines = append(lines, fmt.Sprintf("- `%s` ← *this PR*", currentBranch))
+
+	// Walk downstack from just below current to the bottom, skipping merged branches
+	found := false
+	for i := len(s.Branches) - 1; i >= 0; i-- {
+		b := s.Branches[i]
+		if b.Branch == currentBranch {
+			found = true
+			continue
+		}
+		if !found {
+			continue
+		}
+		if b.IsMerged() {
+			continue
+		}
+		if b.PullRequest != nil && b.PullRequest.URL != "" {
+			lines = append(lines, fmt.Sprintf("- `%s` %s", b.Branch, b.PullRequest.URL))
+		} else {
+			lines = append(lines, fmt.Sprintf("- `%s`", b.Branch))
+		}
+	}
+
+	// Trunk entry
+	lines = append(lines, fmt.Sprintf("- `%s` (base)", s.Trunk.Branch))
+
+	body := "---\n\n**Stacked Pull Requests**\n" + strings.Join(lines, "\n")
+	body += fmt.Sprintf(
+		"\n\n<sub>Stack created with <a href=\"https://github.com/github/gh-stack\">GitHub Stacks CLI</a> • <a href=\"%s\">Give Feedback 💬</a></sub>",
+		feedbackBaseURL,
+	)
+
+	return body
+}
+
 // humanize replaces hyphens and underscores with spaces.
 func humanize(s string) string {
 	return strings.Map(func(r rune) rune {

cmd/push_test.go

@@ -0,0 +1,121 @@
+package cmd
+
+import (
+	"testing"
+
+	"github.com/github/gh-stack/internal/stack"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestGeneratePRBody(t *testing.T) {
+	tests := []struct {
+		name          string
+		stack         *stack.Stack
+		currentBranch string
+		wantContains  []string
+		wantAbsent    []string
+	}{
+		{
+			name: "single branch stack",
+			stack: &stack.Stack{
+				Trunk:    stack.BranchRef{Branch: "main"},
+				Branches: []stack.BranchRef{{Branch: "feature"}},
+			},
+			currentBranch: "feature",
+			wantContains: []string{
+				"---",
+				"**Stacked Pull Requests**",
+				"- `feature` ← *this PR*",
+				"- `main` (base)",
+				"GitHub Stacks CLI",
+				feedbackBaseURL,
+			},
+		},
+		{
+			name: "multi-branch current is topmost",
+			stack: &stack.Stack{
+				Trunk: stack.BranchRef{Branch: "main"},
+				Branches: []stack.BranchRef{
+					{Branch: "part-1", PullRequest: &stack.PullRequestRef{Number: 1, URL: "https://github.com/org/repo/pull/1"}},
+					{Branch: "part-2", PullRequest: &stack.PullRequestRef{Number: 2, URL: "https://github.com/org/repo/pull/2"}},
+					{Branch: "part-3"},
+				},
+			},
+			currentBranch: "part-3",
+			wantContains: []string{
+				"- `part-3` ← *this PR*",
+				"- `part-2` https://github.com/org/repo/pull/2",
+				"- `part-1` https://github.com/org/repo/pull/1",
+				"- `main` (base)",
+			},
+		},
+		{
+			name: "current is in the middle excludes upstack",
+			stack: &stack.Stack{
+				Trunk: stack.BranchRef{Branch: "main"},
+				Branches: []stack.BranchRef{
+					{Branch: "part-1", PullRequest: &stack.PullRequestRef{Number: 1, URL: "https://github.com/org/repo/pull/1"}},
+					{Branch: "part-2"},
+					{Branch: "part-3"},
+				},
+			},
+			currentBranch: "part-2",
+			wantContains: []string{
+				"- `part-2` ← *this PR*",
+				"- `part-1` https://github.com/org/repo/pull/1",
+				"- `main` (base)",
+			},
+			wantAbsent: []string{
+				"part-3",
+			},
+		},
+		{
+			name: "merged branches are skipped",
+			stack: &stack.Stack{
+				Trunk: stack.BranchRef{Branch: "main"},
+				Branches: []stack.BranchRef{
+					{Branch: "part-1", PullRequest: &stack.PullRequestRef{Number: 1, URL: "https://github.com/org/repo/pull/1", Merged: true}},
+					{Branch: "part-2", PullRequest: &stack.PullRequestRef{Number: 2, URL: "https://github.com/org/repo/pull/2"}},
+					{Branch: "part-3"},
+				},
+			},
+			currentBranch: "part-3",
+			wantContains: []string{
+				"- `part-3` ← *this PR*",
+				"- `part-2` https://github.com/org/repo/pull/2",
+				"- `main` (base)",
+			},
+			wantAbsent: []string{
+				"part-1",
+			},
+		},
+		{
+			name: "downstack branch without PR shows branch name only",
+			stack: &stack.Stack{
+				Trunk: stack.BranchRef{Branch: "main"},
+				Branches: []stack.BranchRef{
+					{Branch: "part-1"},
+					{Branch: "part-2"},
+				},
+			},
+			currentBranch: "part-2",
+			wantContains: []string{
+				"- `part-2` ← *this PR*",
+				"- `part-1`",
+				"- `main` (base)",
+			},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got := generatePRBody(tt.stack, tt.currentBranch)
+			for _, want := range tt.wantContains {
+				assert.Contains(t, got, want)
+			}
+			for _, absent := range tt.wantAbsent {
+				assert.NotContains(t, got, absent)
+			}
+		})
+	}
+}