Skip to content

feat(git): track request source branch as upstream on checkout #730

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
skevetter merged 1 commit into from
Jul 24, 2026
+81 −21
Merged

feat(git): track request source branch as upstream on checkout #730

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
71 changes: 50 additions & 21 deletions pkg/git/repo.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,20 @@ import (
"github.com/devsy-org/devsy/pkg/log"
)

// Repo is a handle to a git repository at a filesystem path.
type Repo struct {
path string
env []string
runner Runner
}

// RepoOption configures a Repo.
type RepoOption func(*Repo)

// WithEnv appends extra environment entries applied to every operation.
func WithEnv(env []string) RepoOption {
return func(r *Repo) {
r.env = append(r.env, env...)
}
}

// WithStrictHostKeyChecking appends the default SSH/terminal environment honoring the given policy.
func WithStrictHostKeyChecking(strict bool) RepoOption {
return WithEnv(GetDefaultExtraEnv(strict))
}
Expand All @@ -38,7 +34,6 @@ func WithRunner(runner Runner) RepoOption {
}
}

// At returns a Repo rooted at path.
func At(path string, opts ...RepoOption) *Repo {
r := &Repo{path: path, runner: defaultRunner}
for _, opt := range opts {
Expand All @@ -50,7 +45,6 @@ func At(path string, opts ...RepoOption) *Repo {
return r
}

// Path returns the repository's filesystem path.
func (r *Repo) Path() string {
return r.path
}
Expand All @@ -64,15 +58,13 @@ const (
ResetHard ResetMode = "--hard"
)

// Fetch fetches the given refspec from origin.
func (r *Repo) Fetch(ctx context.Context, refspec string) error {
if err := r.runLogged(ctx, "fetch", "origin", refspec); err != nil {
return fmt.Errorf("fetch %q: %w", refspec, err)
}
return nil
}

// Switch switches the working tree to an existing branch.
func (r *Repo) Switch(ctx context.Context, branch string) error {
if _, err := r.run(ctx, "switch", branch); err != nil {
return fmt.Errorf("switch to branch %q: %w", branch, err)
Expand All @@ -81,10 +73,8 @@ func (r *Repo) Switch(ctx context.Context, branch string) error {
}

// CheckoutPR fetches a pull/merge request into a local branch and switches to
// it. The request number is taken from prRef; the remote refspec is resolved
// against repoURL's hosting provider, falling back to the other known
// conventions when the detected one has no such ref (e.g. self-hosted GitLab on
// a custom domain that URL detection can't recognize).
// it, trying each provider convention so a self-hosted host that URL detection
// can't recognize still resolves against the other's refspec.
func (r *Repo) CheckoutPR(ctx context.Context, repoURL, prRef string) error {
number := prNumber(prRef)
if number == "" {
Expand All @@ -99,7 +89,11 @@ func (r *Repo) CheckoutPR(ctx context.Context, repoURL, prRef string) error {

err := r.Fetch(ctx, refspec+":"+prBranch)
if err == nil {
return r.Switch(ctx, prBranch)
if err := r.Switch(ctx, prBranch); err != nil {
return err
}
r.trackRequestSourceBranch(ctx, prBranch)
return nil
}
if !isMissingRefError(err) {
return err
Expand All @@ -122,7 +116,6 @@ func isMissingRefError(err error) bool {
strings.Contains(msg, "not found in upstream")
}

// Reset moves HEAD to commit using the given mode.
func (r *Repo) Reset(ctx context.Context, commit string, mode ResetMode) error {
if err := r.runLogged(ctx, "reset", string(mode), commit); err != nil {
return fmt.Errorf("reset head to %q: %w", commit, err)
Expand All @@ -147,13 +140,10 @@ func (r *Repo) LsTree(ctx context.Context, ref string) ([]string, error) {
return splitLines(res.Stdout), nil
}

// Clone clones repository into the repo's path using the given options.
func (r *Repo) Clone(ctx context.Context, repository string, options ...Option) error {
return r.cloneWith(ctx, repository, newCloneConfig(options...))
}

// CloneFromInfo clones the repository described by gitInfo into the repo's path,
// using the given credential helper and options.
func (r *Repo) CloneFromInfo(
ctx context.Context,
gitInfo *GitInfo,
Expand Down Expand Up @@ -189,7 +179,7 @@ func (r *Repo) CloneFromInfo(
}

// CredentialFill runs `git credential fill`, feeding request on stdin and
// returning git's response. Used to resolve credentials via configured helpers.
// returning git's response.
func (r *Repo) CredentialFill(ctx context.Context, request string) (string, error) {
res, err := r.runner.Run(ctx, RunOptions{
Dir: r.path,
Expand All @@ -203,7 +193,48 @@ func (r *Repo) CredentialFill(ctx context.Context, request string) (string, erro
return string(res.Stdout), nil
}

// run executes a git subcommand in the repository, capturing its output.
// trackRequestSourceBranch best-effort sets prBranch's upstream to the origin
// branch it was opened from, matched by commit since the head ref lacks the
// branch name. Forks, shallow clones, and ambiguous matches stay untracked.
func (r *Repo) trackRequestSourceBranch(ctx context.Context, prBranch string) {
source, err := r.originBranchAt(ctx, prBranch)
if err != nil {
log.Debugf("could not resolve source branch for %s: %v", prBranch, err)
return
}
if source == "" {
return
}
if _, err := r.run(ctx, "branch", "--set-upstream-to="+source, prBranch); err != nil {
log.Debugf("could not set upstream of %s to %s: %v", prBranch, source, err)
return
}
log.Debugf("branch %s now tracks %s", prBranch, source)
}

// originBranchAt returns the origin branch whose tip is rev's commit, or "" when
// there is not exactly one (origin/HEAD aside).
func (r *Repo) originBranchAt(ctx context.Context, rev string) (string, error) {
res, err := r.run(ctx, "for-each-ref",
"--points-at", rev,
"--format=%(refname:short)",
"refs/remotes/origin")
if err != nil {
return "", err
}
var matches []string
for _, branch := range splitLines(res.Stdout) {
if branch == "origin" || branch == "origin/HEAD" {
continue
}
matches = append(matches, branch)
}
if len(matches) != 1 {
return "", nil
}
return matches[0], nil
}

func (r *Repo) run(ctx context.Context, args ...string) (RunResult, error) {
return r.runner.Run(ctx, RunOptions{
Dir: r.path,
Expand All @@ -227,7 +258,6 @@ func (r *Repo) runLogged(ctx context.Context, args ...string) error {
return err
}

// cloneWith executes a `git clone` with the given config, streaming output to the logs.
func (r *Repo) cloneWith(ctx context.Context, repository string, c cloneConfig) error {
w := log.Writer(log.LevelInfo)
defer func() { _ = w.Close() }()
Expand All @@ -246,7 +276,6 @@ func (r *Repo) cloneWith(ctx context.Context, repository string, c cloneConfig)
return err
}

// splitLines splits command output into non-empty trimmed lines.
func splitLines(b []byte) []string {
var lines []string
for line := range strings.SplitSeq(string(b), "\n") {
Expand Down
31 changes: 31 additions & 0 deletions pkg/git/repo_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,37 @@ func TestRepoCheckoutPRNonRefErrorNoFallback(t *testing.T) {
assert.Equal(t, 1, len(fake.calls))
}

func TestRepoCheckoutPRTracksSourceBranch(t *testing.T) {
// for-each-ref resolves the source branch by commit; a single match is
// adopted as the local branch's upstream.
fake := &fakeRunner{stdout: []byte("origin/feature-x\n")}
repo := At("/tmp/repo", WithRunner(fake))

err := repo.CheckoutPR(context.Background(), testGitLabURL, "merge-requests/7/head")
assert.NilError(t, err)
assert.DeepEqual(t, []string{subFetch, originRemote, testMRRefSpec}, fake.calls[0].Args)
assert.DeepEqual(t, []string{subSwitch, testMRLocal}, fake.calls[1].Args)
assert.DeepEqual(t, []string{
"for-each-ref", "--points-at", testMRLocal,
"--format=%(refname:short)", "refs/remotes/origin",
}, fake.calls[2].Args)
assert.DeepEqual(t, []string{
"branch", "--set-upstream-to=origin/feature-x", testMRLocal,
}, fake.calls[3].Args)
}

func TestRepoCheckoutPRAmbiguousSourceBranchLeftUntracked(t *testing.T) {
// More than one origin branch points at the head (e.g. the default branch
// too): the match is ambiguous, so no upstream is configured.
fake := &fakeRunner{stdout: []byte("origin/HEAD\norigin/main\norigin/feature-x\n")}
repo := At("/tmp/repo", WithRunner(fake))

err := repo.CheckoutPR(context.Background(), testGitLabURL, "merge-requests/7/head")
assert.NilError(t, err)
assert.Equal(t, 3, len(fake.calls)) // fetch, switch, for-each-ref — no set-upstream
assert.Equal(t, "for-each-ref", fake.calls[2].Args[0])
}

func TestRepoLsRemote(t *testing.T) {
fake := &fakeRunner{}
repo := At("", WithRunner(fake))
Expand Down
Loading