open PRs as draft by default by skarim · Pull Request #76 · github/gh-stack · GitHub
Skip to content

open PRs as draft by default #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
skarim merged 2 commits into from
May 11, 2026
Merged

open PRs as draft by default #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bc0fc50
open prs as draft by default
skarim May 5, 2026
5ba2b00
apply suggested docs updates from code review
skarim May 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
17 changes: 14 additions & 3 deletions cmd/link.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import (

type linkOptions struct {
base string
draft bool
open bool
remote string
}

Expand Down Expand Up @@ -51,7 +51,7 @@ the new PRs (existing PRs are never removed).`,
}

cmd.Flags().StringVar(&opts.base, "base", "main", "Base branch for the bottom of the stack")
cmd.Flags().BoolVar(&opts.draft, "draft", false, "Create new PRs as drafts")
cmd.Flags().BoolVar(&opts.open, "open", false, "Mark new and existing PRs as ready for review")
cmd.Flags().StringVar(&opts.remote, "remote", "", "Remote to push to (defaults to auto-detected remote)")
Comment thread
skarim marked this conversation as resolved.

return cmd
Expand Down Expand Up @@ -321,7 +321,7 @@ func createMissingPRs(cfg *config.Config, client github.ClientOps, opts *linkOpt
title := humanize(arg)
body := generatePRBody("")

newPR, err := client.CreatePR(baseBranch, arg, title, body, opts.draft)
newPR, err := client.CreatePR(baseBranch, arg, title, body, !opts.open)
if err != nil {
cfg.Errorf("failed to create PR for branch %s: %v", arg, err)
return nil, ErrAPIFailure
Expand Down Expand Up @@ -375,6 +375,17 @@ func fixBaseBranches(cfg *config.Config, client github.ClientOps, opts *linkOpti
cfg.PRLink(r.prNumber, r.prURL), expectedBase)
}
}

// Convert draft PR to ready for review when --open is set.
if opts.open && pr.IsDraft {
if err := client.MarkPRReadyForReview(pr.ID); err != nil {
cfg.Warningf("failed to mark PR %s as ready for review: %v",
cfg.PRLink(r.prNumber, r.prURL), err)
} else {
cfg.Successf("Marked PR %s as ready for review",
cfg.PRLink(r.prNumber, r.prURL))
}
}
}
}

Expand Down
113 changes: 110 additions & 3 deletions cmd/link_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -477,7 +477,7 @@ func TestLink_BranchNames_AllNeedPRs(t *testing.T) {
assert.Contains(t, output, "Created stack with 3 PRs")
}

func TestLink_BranchNames_DraftFlag(t *testing.T) {
func TestLink_BranchNames_DefaultDraft(t *testing.T) {
restore := git.SetOps(newLinkGitMock("feat-a", "feat-b"))
defer restore()

Expand Down Expand Up @@ -512,13 +512,120 @@ func TestLink_BranchNames_DraftFlag(t *testing.T) {
}

cmd := LinkCmd(cfg)
cmd.SetArgs([]string{"--draft", "feat-a", "feat-b"})
cmd.SetArgs([]string{"feat-a", "feat-b"})
cmd.SetOut(io.Discard)
cmd.SetErr(io.Discard)
err := cmd.Execute()

assert.NoError(t, err)
assert.True(t, createdDraft, "PRs should be created as drafts by default")
}

func TestLink_BranchNames_OpenFlag(t *testing.T) {
restore := git.SetOps(newLinkGitMock("feat-a", "feat-b"))
defer restore()

var createdDraft bool
prCounter := 0

cfg, _, _ := config.NewTestConfig()
cfg.GitHubClientOverride = &github.MockClient{
FindPRForBranchFn: func(branch string) (*github.PullRequest, error) {
return nil, nil
},
FindPRByNumberFn: func(n int) (*github.PullRequest, error) {
heads := map[int]string{1: "feat-a", 2: "feat-b"}
bases := map[int]string{1: "main", 2: "feat-a"}
if h, ok := heads[n]; ok {
return &github.PullRequest{Number: n, HeadRefName: h, BaseRefName: bases[n]}, nil
}
return nil, nil
},
CreatePRFn: func(base, head, title, body string, draft bool) (*github.PullRequest, error) {
createdDraft = draft
prCounter++
return &github.PullRequest{
Number: prCounter, HeadRefName: head, BaseRefName: base,
URL: fmt.Sprintf("https://github.com/o/r/pull/%d", prCounter),
}, nil
},
ListStacksFn: func() ([]github.RemoteStack, error) {
return []github.RemoteStack{}, nil
},
CreateStackFn: func([]int) (int, error) { return 1, nil },
}

cmd := LinkCmd(cfg)
cmd.SetArgs([]string{"--open", "feat-a", "feat-b"})
cmd.SetOut(io.Discard)
cmd.SetErr(io.Discard)
err := cmd.Execute()

assert.NoError(t, err)
assert.False(t, createdDraft, "PRs should not be created as drafts when --open is set")
}

func TestLink_OpenFlag_ConvertsDraftPRs(t *testing.T) {
restore := git.SetOps(newLinkGitMock("feat-a", "feat-b"))
defer restore()

var markedReady []string

cfg, _, errR := config.NewTestConfig()
cfg.GitHubClientOverride = &github.MockClient{
FindPRForBranchFn: func(branch string) (*github.PullRequest, error) {
switch branch {
case "feat-a":
return &github.PullRequest{
Number: 1, ID: "PR_1", HeadRefName: "feat-a", BaseRefName: "main",
IsDraft: true, URL: "https://github.com/o/r/pull/1",
}, nil
case "feat-b":
return &github.PullRequest{
Number: 2, ID: "PR_2", HeadRefName: "feat-b", BaseRefName: "feat-a",
IsDraft: true, URL: "https://github.com/o/r/pull/2",
}, nil
}
return nil, nil
},
FindPRByNumberFn: func(n int) (*github.PullRequest, error) {
switch n {
case 1:
return &github.PullRequest{
Number: 1, ID: "PR_1", HeadRefName: "feat-a", BaseRefName: "main",
IsDraft: true, URL: "https://github.com/o/r/pull/1",
}, nil
case 2:
return &github.PullRequest{
Number: 2, ID: "PR_2", HeadRefName: "feat-b", BaseRefName: "feat-a",
IsDraft: true, URL: "https://github.com/o/r/pull/2",
}, nil
}
return nil, nil
},
MarkPRReadyForReviewFn: func(prID string) error {
markedReady = append(markedReady, prID)
return nil
},
ListStacksFn: func() ([]github.RemoteStack, error) {
return []github.RemoteStack{}, nil
},
CreateStackFn: func([]int) (int, error) { return 1, nil },
}

cmd := LinkCmd(cfg)
cmd.SetArgs([]string{"--open", "feat-a", "feat-b"})
cmd.SetOut(io.Discard)
cmd.SetErr(io.Discard)
err := cmd.Execute()

cfg.Err.Close()
errOut, _ := io.ReadAll(errR)
output := string(errOut)

assert.NoError(t, err)
assert.True(t, createdDraft, "PRs should be created as drafts when --draft is set")
assert.Equal(t, []string{"PR_1", "PR_2"}, markedReady, "both draft PRs should be marked ready")
assert.Contains(t, output, "Marked PR")
}

func TestLink_MixedArgs_PRNumberAndBranch(t *testing.T) {
Expand Down
17 changes: 14 additions & 3 deletions cmd/submit.go
View file
Open in desktop
Loading
Loading