Allow argument to `gh repo set-default` to be the name of a remote #10002

ADKaster · 2024-12-04T04:50:19Z

I'm not sure if this is a complete fix, as the UX for passing a random string (or a string you thought was a remote name) is now a bit worse.

It also doesn't actually check with git whether the remote name actually corresponds with a real git remote, which might give a better experience as well.

But this does seem to be the minimum change to let me type gh repo set-default upstream instead of having to do gh repo set-default $(git remote get-url upstream), which was super annoying :).

Also perhaps there should be some magic sauce to add a remote named upstream or github if you specify it and the only remote is origin and you've cloned a fork?

andyfeller · 2024-12-11T14:12:02Z

@ADKaster : Thanks for opening this PR and apologies for delay following up! 🙇 Catching up on the issue, I'm going to dig into this and the related code given the concerns you alluded to. 👍

andyfeller

Thank you again for your patience! 🙇 Couple of concerns regarding these changes that I think we can address and get this into ship shape!

andyfeller · 2024-12-12T14:32:06Z

pkg/cmd/repo/setdefault/setdefault.go

+			if len(args) > 0 {
+				var err error
+				opts.Repo, err = parseRepo(args[0], opts)
+				if err != nil {
+					return err
+				}
+			}
+


Is there a reason this logic needed to be moved to later within RunE? Does this create a problem above because opts.Repo is unset?

Depending on the motivation for moving the logic, this might have to be undone as non-interactive usage will break because opts.Repo is unset.

cli/pkg/cmd/repo/setdefault/setdefault.go

Lines 80 to 83 in b4b8e8a

RunE: func(cmd *cobra.Command, args []string) error {

if !opts.ViewMode && !opts.IO.CanPrompt() && opts.Repo == nil {

return cmdutil.FlagErrorf("repository required when not running interactively")

}

andyfeller · 2024-12-12T14:51:23Z

pkg/cmd/repo/setdefault/setdefault.go

-			if len(args) > 0 {
-				var err error
-				opts.Repo, err = ghrepo.FromFullName(args[0])
-				if err != nil {
-					return err
-				}
-			}
-


Does it make sense to move processing opts.Repo out of RunE and into setDefaultRun?

The spf13/cobra command hooks should be focused on translating cobra arguments and flags into variables that the application logic cares about, however this is no longer as simple as turning owner/repo into ghrepo.Interface. With the changes as-is, we're duplicating logic around remotes and starting to do more application-level behavior outside of the application code.

It might be cleaner and easier to test by changing opts.Repo to a string like opts.RepoOrRemote and defer checking remotes or parsing this as a repo until later in the logic:

cli/pkg/cmd/repo/setdefault/setdefault.go

Lines 172 to 182 in 9bdfa83

if opts.Repo != nil {

for _, knownRepo := range knownRepos {

if ghrepo.IsSame(opts.Repo, knownRepo) {

selectedRepo = opts.Repo

break

}

}

if selectedRepo == nil {

return fmt.Errorf("%s does not correspond to any git remotes", ghrepo.FullName(opts.Repo))

}

}

Error handling around remotes happened earlier in the logic

Application has remote and resolved remote information

RunE logic keeps this logic within the testable code

andyfeller · 2025-01-22T22:53:16Z

@ADKaster : I want to give a gentle nudge if this is a PR you are still interested in contributing to the GitHub CLI. I understand you may have other priorities going on, however I'm unsure if you saw my comments above and if this is something you're still interested in.

ADKaster · 2025-01-23T17:58:34Z

@andyfeller sorry for the lack of response! I did see the comments, but I didn't have the capacity to re-open my Go IDE and dive back into the code. I mostly opened this PR because I was annoyed that I had to do gh repo set-default $(git remote get-url upstream) to get the 'obvious' behavior 😅 . I think that the reason I had to move that parameter around was because in order to query the set of repos, it had to be initialized first. I don't think I'll have the capacity to dive into this more deeply any time soon.

andyfeller · 2025-01-24T13:26:27Z

@andyfeller sorry for the lack of response! I did see the comments, but I didn't have the capacity to re-open my Go IDE and dive back into the code. I mostly opened this PR because I was annoyed that I had to do gh repo set-default $(git remote get-url upstream) to get the 'obvious' behavior 😅 . I think that the reason I had to move that parameter around was because in order to query the set of repos, it had to be initialized first. I don't think I'll have the capacity to dive into this more deeply any time soon.

I appreciate pain-driven development is what motivates a lot of OSS development! 😆

Thanks for the context. 🙇 Given that, I'm going to see if I can shape this up and get it over the line. I wanted to check in before presuming. ❤️

andyfeller · 2025-01-24T15:22:04Z

pkg/cmd/repo/setdefault/setdefault.go

+	remotes, err := opts.Remotes()
+	if err != nil {
+		return nil, err
+	}


My major concern with the code as-is is that multiple calls to resolve git remotes via opts.Remotes() does not reuse previously cached results as stated in #10103.

Perhaps the expense isn't significant enough to move forward here. It is mostly a question whether instead of providing a function to resolve the remotes if an actual remote resolver is provided 🤔

Allow argument to gh repo set-default to be the name of a remote

b4b8e8a

ADKaster requested a review from a team as a code owner December 4, 2024 04:50

ADKaster requested a review from andyfeller December 4, 2024 04:50

cliAutomation added the external pull request originating outside of the CLI core team label Dec 4, 2024

andyfeller reviewed Dec 12, 2024

View reviewed changes

This comment was marked as spam.

Sign in to view

cli blocked 154577674 Jan 4, 2025

andyfeller reviewed Jan 24, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Allow argument to `gh repo set-default` to be the name of a remote #10002

Allow argument to `gh repo set-default` to be the name of a remote #10002

Uh oh!

ADKaster commented Dec 4, 2024 •

edited

Loading

Uh oh!

andyfeller commented Dec 11, 2024

Uh oh!

andyfeller left a comment

Uh oh!

andyfeller Dec 12, 2024

Uh oh!

andyfeller Dec 12, 2024

Uh oh!

This comment was marked as spam.

This comment was marked as spam.

andyfeller commented Jan 22, 2025

Uh oh!

ADKaster commented Jan 23, 2025

Uh oh!

andyfeller commented Jan 24, 2025

Uh oh!

andyfeller Jan 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	RunE: func(cmd *cobra.Command, args []string) error {
	if !opts.ViewMode && !opts.IO.CanPrompt() && opts.Repo == nil {
	return cmdutil.FlagErrorf("repository required when not running interactively")
	}

	if opts.Repo != nil {
	for _, knownRepo := range knownRepos {
	if ghrepo.IsSame(opts.Repo, knownRepo) {
	selectedRepo = opts.Repo
	break
	}
	}
	if selectedRepo == nil {
	return fmt.Errorf("%s does not correspond to any git remotes", ghrepo.FullName(opts.Repo))
	}
	}

Allow argument to gh repo set-default to be the name of a remote #10002

Are you sure you want to change the base?

Allow argument to gh repo set-default to be the name of a remote #10002

Uh oh!

Conversation

ADKaster commented Dec 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

andyfeller commented Dec 11, 2024

Uh oh!

andyfeller left a comment

Choose a reason for hiding this comment

Uh oh!

andyfeller Dec 12, 2024

Choose a reason for hiding this comment

Uh oh!

andyfeller Dec 12, 2024

Choose a reason for hiding this comment

Uh oh!

This comment was marked as spam.

This comment was marked as spam.

andyfeller commented Jan 22, 2025

Uh oh!

ADKaster commented Jan 23, 2025

Uh oh!

andyfeller commented Jan 24, 2025

Uh oh!

andyfeller Jan 24, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Allow argument to `gh repo set-default` to be the name of a remote #10002

Allow argument to `gh repo set-default` to be the name of a remote #10002

ADKaster commented Dec 4, 2024 •

edited

Loading