[gh repo view] Improve error message for forked repo #10334

iamazeem · 2025-01-30T07:39:32Z

$ bin/gh repo view
X No default remote repository has been set for this directory.

please run `gh repo set-default` to select a default remote repository.
To learn more about the default repository, run: gh repo set-default --help

andyfeller

Thanks for picking this up, @iamazeem!

I noticed some inconsistencies in the other places of the codebase where similar messages are outputted and felt we should try to bring this more into alignment.

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

Line 126 in 5557958

    
           fmt.Fprintln(opts.IO.ErrOut, "no default repository has been set; use `gh repo set-default` to select one")

cli/pkg/cmd/repo/clone/clone.go

Lines 217 to 221 in 5557958

    
           connectedToTerminal := opts.IO.IsStdoutTTY() 
        
           if connectedToTerminal { 
        
           	cs := opts.IO.ColorScheme() 
        
           	fmt.Fprintf(opts.IO.ErrOut, "%s Repository %s set as the default repository. To learn more about the default repository, run: gh repo set-default --help\n", cs.WarningIcon(), cs.Bold(ghrepo.FullName(canonicalRepo.Parent))) 
        
           }

cli/pkg/cmd/repo/fork/fork.go

Lines 380 to 383 in 5557958

    
           if connectedToTerminal { 
        
           	fmt.Fprintf(stderr, "%s Cloned fork\n", cs.SuccessIcon()) 
        
           	fmt.Fprintf(stderr, "%s Repository %s set as the default repository. To learn more about the default repository, run: gh repo set-default --help\n", cs.WarningIcon(), cs.Bold(ghrepo.FullName(repoToFork))) 
        
           }

Unlike the latter 2 snippets, we still want this message to go out even if non-TTY.

Example

$ ~/Documents/workspace/cli/cli/bin/gh repo view
X No default remote repository has been set. To learn more about the default repository, run: gh repo set-default --help

please run `gh repo set-default` to select a default remote repository.

iamazeem · 2025-02-11T05:53:38Z

@andyfeller: Please review again. Thanks!
Not sure if I got your last comment completely.
I'd appreciate some more details if it's not what you intended to convey.

andyfeller

LGTM

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [cli/cli](https://github.com/cli/cli) | minor | `v2.67.0` -> `v2.68.0` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>cli/cli (cli/cli)</summary> ### [`v2.68.0`](https://github.com/cli/cli/releases/tag/v2.68.0): GitHub CLI 2.68.0 [Compare Source](cli/cli@v2.67.0...v2.68.0) #### What's Changed ##### ✨ Features - \[gh repo view] Improve error message for forked repo by [@iamazeem](https://github.com/iamazeem) in cli/cli#10334 - Add signer-digest, source-ref, and source-digest options for `gh attestation verify` by [@malancas](https://github.com/malancas) in cli/cli#10308 - \[gh pr checkout] Add --no-tags option to git fetch commands in checkout by [@latzskim](https://github.com/latzskim) in cli/cli#10479 - \[`gh issue/pr comment`] Add `--create-if-none` and prompts to create a comment if no comment already exists by [@latzskim](https://github.com/latzskim) in cli/cli#10427 - \[gh cache delete --all] Add `--succeed-on-no-caches` flag to return exit code 0 by [@iamazeem](https://github.com/iamazeem) in cli/cli#10327 - \[gh release create] Fail when there are no new commits since the last release by [@iamazeem](https://github.com/iamazeem) in cli/cli#10398 - update default upstream when forking repo during MR creation by [@daviddl9](https://github.com/daviddl9) in cli/cli#10458 ##### 🐛 Fixes - Refactor `GetLocalAttestations` and clean up custom registry transport by [@malancas](https://github.com/malancas) in cli/cli#10382 - Check `GH_REPO` too in addition to `--repo` for disambiguation by [@williammartin](https://github.com/williammartin) in cli/cli#10539 - (Fixes `gh secret` subcommands not working outside of a repository) - Fix unhandled panic in FindWorkflow and add tests by [@jtmcg](https://github.com/jtmcg) in cli/cli#10521 - Fix checkout when URL arg is from fork and cwd is upstream by [@williammartin](https://github.com/williammartin) in cli/cli#10512 - \[gh api] Escape package name (URL encoding) for packages endpoint by [@iamazeem](https://github.com/iamazeem) in cli/cli#10384 - Fix `remoteResolver` caching issue by [@iamazeem](https://github.com/iamazeem) in cli/cli#10456 - Fix gh project item-edit to allow --number 0 as a valid value by [@aryanbhosale](https://github.com/aryanbhosale) in cli/cli#10417 - Add mutex to fix race in attestation test client by [@codysoyland](https://github.com/codysoyland) in cli/cli#10439 - Base64 decode GPG passphrase in deployment workflow by [@BagToad](https://github.com/BagToad) in cli/cli#10546 ##### 📚 Docs & Chores - Deep Dive Document Release Process by [@williammartin](https://github.com/williammartin) in cli/cli#10503 - Inconsistent format of examples in help text by [@iamazeem](https://github.com/iamazeem) in cli/cli#10508 - Inconsistent format of description of flags (starting with lowercase letter) by [@iamazeem](https://github.com/iamazeem) in cli/cli#10507 - Update Go version to 1.23 in CONTRIBUTING.md by [@williammartin](https://github.com/williammartin) in cli/cli#10504 - Fix minor auth login help typo by [@williammartin](https://github.com/williammartin) in cli/cli#10501 - docs: document how to revoke `gh` OAuth tokens in `auth logout`'s help by [@BagToad](https://github.com/BagToad) in cli/cli#10490 - chore: update codespaces Go version by [@BagToad](https://github.com/BagToad) in cli/cli#10491 - Allow injection of TUFMetadataDir in tests by [@williammartin](https://github.com/williammartin) in cli/cli#10478 - refactor: use a more straightforward return value by [@beforetech](https://github.com/beforetech) in cli/cli#10489 - Use subtests in attestation verification integration tests by [@williammartin](https://github.com/williammartin) in cli/cli#10463 - Fix typo in README by [@iamazeem](https://github.com/iamazeem) in cli/cli#10445 - Update usage to lower-kebab-case by [@iamazeem](https://github.com/iamazeem) in cli/cli#10447 - Standardize URLs by [@iamazeem](https://github.com/iamazeem) in cli/cli#10429 - Remove trailing whitespace by [@iamazeem](https://github.com/iamazeem) in cli/cli#10430 #####

Dependencies - Bump actions/attest-build-provenance from 2.2.0 to 2.2.2 by [@dependabot](https://github.com/dependabot) in cli/cli#10518 - Bump github.com/go-jose/go-jose/v4 from 4.0.2 to 4.0.5 by [@dependabot](https://github.com/dependabot) in cli/cli#10499 - Bump github.com/spf13/pflag from 1.0.5 to 1.0.6 by [@dependabot](https://github.com/dependabot) in cli/cli#10338 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

[gh repo view] Improve error message for forked repo

e1d1f21

iamazeem requested a review from a team as a code owner January 30, 2025 07:39

iamazeem requested a review from andyfeller January 30, 2025 07:39

cliAutomation added the external pull request originating outside of the CLI core team label Jan 30, 2025

Align no default repo message with other uses

81eeaca

andyfeller approved these changes Feb 10, 2025

View reviewed changes

andyfeller enabled auto-merge February 10, 2025 22:30

Address review comments

cdc7cae

auto-merge was automatically disabled February 11, 2025 04:35
Head branch was pushed to by a user without write access

Update tests

eb44ec2

iamazeem requested a review from andyfeller February 11, 2025 05:52

andyfeller approved these changes Feb 12, 2025

View reviewed changes

andyfeller merged commit cdb44f8 into cli:trunk Feb 12, 2025
9 checks passed

iamazeem deleted the 9132-gh-repo-view-set-default branch February 12, 2025 16:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[gh repo view] Improve error message for forked repo #10334

[gh repo view] Improve error message for forked repo #10334

iamazeem commented Jan 30, 2025 •

edited

Loading

andyfeller left a comment •

edited

Loading

iamazeem commented Feb 11, 2025

andyfeller left a comment

	connectedToTerminal := opts.IO.IsStdoutTTY()
	if connectedToTerminal {
	cs := opts.IO.ColorScheme()
	fmt.Fprintf(opts.IO.ErrOut, "%s Repository %s set as the default repository. To learn more about the default repository, run: gh repo set-default --help\n", cs.WarningIcon(), cs.Bold(ghrepo.FullName(canonicalRepo.Parent)))
	}

	if connectedToTerminal {
	fmt.Fprintf(stderr, "%s Cloned fork\n", cs.SuccessIcon())
	fmt.Fprintf(stderr, "%s Repository %s set as the default repository. To learn more about the default repository, run: gh repo set-default --help\n", cs.WarningIcon(), cs.Bold(ghrepo.FullName(repoToFork)))
	}

[gh repo view] Improve error message for forked repo #10334

[gh repo view] Improve error message for forked repo #10334

Conversation

iamazeem commented Jan 30, 2025 • edited Loading

andyfeller left a comment • edited Loading

Choose a reason for hiding this comment

Example

iamazeem commented Feb 11, 2025

andyfeller left a comment

Choose a reason for hiding this comment

iamazeem commented Jan 30, 2025 •

edited

Loading

andyfeller left a comment •

edited

Loading