rewrite `gh repo create` by meiji163 · Pull Request #4578 · cli/cli

meiji163 · 2021-10-20T19:23:29Z

This PR rewrites gh repo create following #4567 to fix bugs, improve UX, and add requested features (Ref: #2184).

Fixes #2166, Fixes #893, Fixes #2059, Fixes #2077

Changes

Interactive mode is only for gh repo create with no arguments. Otherwise, all arguments must be passed explicitly.

The new command is backward compatible for scripting purposes except:

the new command will not clone the new repo locally by default. To do this, pass the --clone flag
the new command will not behave differently if the current directory is a git repository.
to create a new remote repo from an existing local repo, the source directory must be supplied with the --source flag

For example, running gh repo create myrepo --public in a local repository will no longer add a remote. It assumes you just want to create a new repository on GitHub. To create a remote repo from your local git repo, use gh repo create myrepo --public --source=. instead

Flags

The following flags are deprecated:

--enable-wiki, replaced by --disable-wiki
--enable-issues, replaced by --disable-issues
--confirm

There are additional new flags:

--source: specify the path to the local git repo
--remote: specify the remote name to add (used with --source)
--push: push local commits to the new repo (used with --source)

see #4567 for more info

Todo

make sure --template has no bugs (Ref: "gh repo create --template" creates an empty repository locally #2290)
only clone one branch for --template
improve usage docs
remove git cloned empty repository warning
- Edit: based on discussion with @mislav and @samcoe we'll keep git output for --clone and --push in case authentication is needed
add more test coverage for --source, --remote, and --push, --clone

… repo-create-rewrite

vilmibm

this is coming along very well~

pkg/cmd/repo/create/create.go

… repo-create-rewrite

mislav

Getting close! I've tested this locally and I love how easy and clear it is to use via explicit command line flags.

pkg/cmd/repo/create/create.go

mislav

Looking great!

Some results from my QA testing:

gh repo create --source . --private --template a/b - I have expected this to error out, but the template flag seems to be ignored.
gh repo create myrepo --source /tmp --private - Since /tmp is not a git repo, this fails, but the error message is misleading: fatal: not a git repository (or any of the parent directories): .git. The error message does not ever mention that /tmp was an invalid git directory, but perhaps it should?
gh repo create myrepo --source . --push --private - My local git repo has no commits, so I have expected this to fail with a descriptive error message, but I get: error: src refspec HEAD does not match any. The remote repo was created and added as a git remote, but I don't think the git error message is descriptive enough for the average user to realize what went wrong. Furthermore, retrying the command (perhaps after creating a git commit) will fail because the remote repo already exists. Perhaps --push should fail early if there are no commits?

pkg/cmd/repo/create/create.go

meiji163 · 2021-11-16T21:23:56Z

gh repo create myrepo --source /tmp --private - Since /tmp is not a git repo, this fails, but the error message is misleading: fatal: not a git repository (or any of the parent directories): .git. The error message does not ever mention that /tmp was an invalid git directory, but perhaps it should?

gh repo create myrepo --source . --push --private - My local git repo has no commits, so I have expected this to fail with a descriptive error message, but I get: error: src refspec HEAD does not match any. The remote repo was created and added as a git remote, but I don't think the git error message is descriptive enough for the average user to realize what went wrong.

I made the errors more descriptive by catching the 128 exit code from git. Let me know if you see any bugs or if the code can be improved

The command will now fail immediately if --push is enabled when there are no commits. Also, the user will not be prompted to push in interactive mode if there are no commits.

mislav

Updates look good! Thank you for the hard work 🙇

See: cli/cli#4578

init commit

35ebd49

meiji163 assigned meiji163 and pxrth9 and unassigned meiji163 Oct 20, 2021

meiji163 added enhancement a request to improve CLI tech-debt A chore that addresses technical debt labels Oct 20, 2021

pxrth9 linked an issue Oct 20, 2021 that may be closed by this pull request

repo create rewrite #4567

Closed

meiji163 and others added 6 commits October 21, 2021 20:33

parse args and flags

aebe095

minor changes

ef7f2f4

simplfy flag errors

ae8a9de

Merge branch 'trunk' into repo-create-rewrite

75aad07

make createRun outline

5f0b7e6

copy funcs from old files

a2b69be

pxrth9 requested review from pxrth9 and removed request for pxrth9 October 27, 2021 18:26

pxrth9 and others added 13 commits October 27, 2021 14:52

comments added

33efe2d

added more changes

5cba06f

createFromScratch

ff0cd9e

Merge branch 'repo-create-rewrite' of https://github.com/cli/cli into…

b9a4730

… repo-create-rewrite

createFromScratch working

d866892

added name changes

55efd96

lint fix

34dffcf

minor change

a69defd

fix deprecated flags

da628b6

Merge branch 'repo-create-rewrite' of https://github.com/cli/cli into…

a4e5949

… repo-create-rewrite

add interactive funcs

302a876

almost done

6fc7d83

Merge branch 'repo-create-rewrite' of https://github.com/cli/cli into…

38412a3

… repo-create-rewrite

vilmibm reviewed Nov 8, 2021

View reviewed changes

pkg/cmd/repo/create/create.go Outdated Show resolved Hide resolved

pkg/cmd/repo/create/create.go Outdated Show resolved Hide resolved

pkg/cmd/repo/create/create.go Outdated Show resolved Hide resolved

meiji163 and others added 5 commits November 8, 2021 15:49

fix confirmation

19788e9

minor fix

240ebd8

improve usage docs, re-enable deprecated flags

60f3098

Merge branch 'repo-create-rewrite' of https://github.com/cli/cli into…

7de91fc

… repo-create-rewrite

bring back function, remove , and fix tests

d059311

mislav suggested changes Nov 10, 2021

View reviewed changes

pxrth9 and others added 4 commits November 10, 2021 10:47

comments resd

5f32c46

resolve mislav's comments

8fbf7f8

remove redundant success msg

c8dfbd1

minor fix in test

25b8fa2

This was referenced Nov 13, 2021

Update gh repo create documentation github/docs#11931

Closed

update gh repo create docs github/docs#11932

Merged

mislav suggested changes Nov 16, 2021

View reviewed changes

pkg/cmd/repo/create/create.go Outdated Show resolved Hide resolved

improve git directory error messages and fix --source flag errors

9f45dcc

meiji163 requested a review from mislav November 16, 2021 21:46

mislav approved these changes Nov 17, 2021

View reviewed changes

mislav merged commit 0a0a358 into trunk Nov 17, 2021

mislav deleted the repo-create-rewrite branch November 17, 2021 19:16

meiji163 mentioned this pull request Nov 17, 2021

gh create repo takes parent directory name if parent directory contains .git #2026

Closed

VictorBatta mentioned this pull request Dec 4, 2021

GitHub CLI 2.3.0 #4855

Closed

jongio mentioned this pull request Dec 13, 2021

gh repo create no longer outputs the created repo info with v2.3.0 #4903

Closed

jenkins-infra-bot mentioned this pull request Dec 20, 2021

[updatecli] Bump ghcli version jenkins-infra/docker-builder#26

Merged

georgalis mentioned this pull request Dec 31, 2021

Known problems with repo create command #2184

Closed

12 tasks

ArnaudLier mentioned this pull request Jan 11, 2022

Maintain current functionality with gh repo create rewrite laravel/installer#219

Merged

brendalf mentioned this pull request Feb 1, 2022

gh repo edit: not clear how to invert --enable-issues #5100

Closed

felddy added a commit to cisagov/gh-skeleton that referenced this pull request May 14, 2022

Remove deprecated --confirm option

2464829

See: cli/cli#4578

felddy mentioned this pull request May 14, 2022

Fix broken calls caused by breaking changes in gh command cisagov/gh-skeleton#16

Merged

8 tasks

dmmqz mentioned this pull request Oct 26, 2025

gh-{repo,repo-create}: fix examples tldr-pages/tldr#19048

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

rewrite `gh repo create`#4578

rewrite `gh repo create`#4578
mislav merged 58 commits intotrunkfrom
repo-create-rewrite

meiji163 commented Oct 20, 2021 •

edited

Loading

Uh oh!

vilmibm left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mislav left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mislav left a comment

Uh oh!

Uh oh!

meiji163 commented Nov 16, 2021 •

edited

Loading

Uh oh!

mislav left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

meiji163 commented Oct 20, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Flags

Todo

Uh oh!

vilmibm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mislav left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mislav left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

meiji163 commented Nov 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mislav left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

meiji163 commented Oct 20, 2021 •

edited

Loading

meiji163 commented Nov 16, 2021 •

edited

Loading