Skip to content

Conversation

@BagToad
Copy link
Member

@BagToad BagToad commented Dec 8, 2024

Description

  • Update gh repo rename help doc.
    • Add Example doc to demo proper usage of the <new-name> arugment.
    • Add details to the Long doc about the intended value of the <new-name> argument.
    • Add details to the Long doc about transferring repository ownership.

Relates to:

Demo

Current

❯ gh repo rename --help
Rename a GitHub repository.

By default, this renames the current repository; otherwise renames the specified repository.

USAGE
  gh repo rename [<new-name>] [flags]

FLAGS
  -R, --repo [HOST/]OWNER/REPO   Select another repository using the [HOST/]OWNER/REPO format
  -y, --yes                      Skip the confirmation prompt

INHERITED FLAGS
  --help   Show help for command

LEARN MORE
  Use `gh <command> <subcommand> --help` for more information about a command.
  Read the manual at https://cli.github.com/manual
  Learn about exit codes using `gh help exit-codes`

Proposed

❯ gh repo rename --help
Rename a GitHub repository.

`<new-name>` is the desired repository name without the owner.

By default, the current repository is renamed. Otherwise, the repository specified
with `--repo` is renamed.

To transfer repository ownership to another user account or organization,
you must follow additional steps on GitHub.com

For more information on transferring repository ownership, see:
<https://docs.github.com/en/repositories/creating-and-managing-repositories/transferring-a-repository>


USAGE
  gh repo rename [<new-name>] [flags]

FLAGS
  -R, --repo [HOST/]OWNER/REPO   Select another repository using the [HOST/]OWNER/REPO format
  -y, --yes                      Skip the confirmation prompt

INHERITED FLAGS
  --help   Show help for command

EXAMPLES
  # Rename the current repository (foo/bar -> foo/baz)
  $ gh repo rename baz
  
  # Rename the specified repository (qux/quux -> qux/baz)
  $ gh repo rename -R qux/quux baz

LEARN MORE
  Use `gh <command> <subcommand> --help` for more information about a command.
  Read the manual at https://cli.github.com/manual
  Learn about exit codes using `gh help exit-codes`

@BagToad BagToad marked this pull request as ready for review December 8, 2024 19:03
@BagToad BagToad requested a review from a team as a code owner December 8, 2024 19:03
@BagToad BagToad requested a review from andyfeller December 8, 2024 19:03
@cliAutomation cliAutomation added the external pull request originating outside of the CLI core team label Dec 8, 2024
@BagToad BagToad changed the title Enhance gh repo rename help doc and prompts to clarify repo owner requirements Enhance gh repo rename help doc and prompts to clarify new repo name should not include owner Dec 8, 2024
@BagToad BagToad force-pushed the kw/cli-10034-repo-rename-docs-and-prompt-updates branch from 143005d to b85f948 Compare December 9, 2024 17:11
@BagToad BagToad changed the title Enhance gh repo rename help doc and prompts to clarify new repo name should not include owner Enhance gh repo rename help doc to clarify new repo name should not include owner Dec 9, 2024
@BagToad BagToad force-pushed the kw/cli-10034-repo-rename-docs-and-prompt-updates branch from b85f948 to 167e868 Compare December 9, 2024 17:16
@BagToad
Copy link
Member Author

BagToad commented Dec 9, 2024

@williammartin I backed out the prompt changes, this PR is now just a help doc update, ready for your review again 🫡

@BagToad BagToad changed the title Enhance gh repo rename help doc to clarify new repo name should not include owner gh repo rename help text clarifies new repo name should not include owner Dec 9, 2024
Copy link
Member

@andyfeller andyfeller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@andyfeller
Copy link
Member

After talking with @BagToad regarding enhancing the logic to throw an error if it seems like the user is providing owner/repo, neither of us felt strong that this had to happen here unless we continued receiving reports, so going to move ahead with merging this.

@BagToad BagToad enabled auto-merge December 9, 2024 19:29
@andyfeller andyfeller dismissed williammartin’s stale review December 10, 2024 21:07

Feedback was addressed

@BagToad BagToad merged commit 9d53b86 into trunk Dec 10, 2024
@BagToad BagToad deleted the kw/cli-10034-repo-rename-docs-and-prompt-updates branch December 10, 2024 21:07
tmeijn pushed a commit to tmeijn/dotfiles that referenced this pull request Dec 21, 2024
This MR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [cli/cli](https://github.com/cli/cli) | minor | `v2.63.2` -> `v2.64.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.64.0`](https://github.com/cli/cli/releases/tag/v2.64.0): GitHub CLI 2.64.0

[Compare Source](cli/cli@v2.63.2...v2.64.0)

#### What's Changed

-   docs: improve docs for browse command as of [#&#8203;5352](cli/cli#5352) by [@&#8203;ankddev](https://github.com/ankddev) in cli/cli#10025
-   Open MR against gh-merge-base by [@&#8203;heaths](https://github.com/heaths) in cli/cli#9712
-   Add integration tests for `gh attestation verify` when the `bundle-from-oci` flag is specified by [@&#8203;malancas](https://github.com/malancas) in cli/cli#10020
-   `gh repo rename` help text clarifies new repo name should not include owner by [@&#8203;BagToad](https://github.com/BagToad) in cli/cli#10044
-   fix: list branches in square brackets in `gh run` and `gh codespace` by [@&#8203;uday-rana](https://github.com/uday-rana) in cli/cli#10043
-   Bump actions/attest-build-provenance from 1.4.4 to 2.1.0 by [@&#8203;dependabot](https://github.com/dependabot) in cli/cli#10056
-   Bump golang.org/x/crypto from 0.29.0 to 0.31.0 by [@&#8203;dependabot](https://github.com/dependabot) in cli/cli#10070
-   Improve documentation and error messaging for local extension installations without executables by [@&#8203;BagToad](https://github.com/BagToad) in cli/cli#9933
-   docs: better document auth scopes by [@&#8203;ankddev](https://github.com/ankddev) in cli/cli#10026
-   Sigstore verifier logic updates by [@&#8203;malancas](https://github.com/malancas) in cli/cli#9999
-   `gh pr merge --delete-branch` exits with error when merge requested via merge queue by [@&#8203;BagToad](https://github.com/BagToad) in cli/cli#10074
-   sundry `gh at inspect` improvements by [@&#8203;phillmv](https://github.com/phillmv) in cli/cli#9954
-   Support `pr view` for intra-org forks by [@&#8203;williammartin](https://github.com/williammartin) in cli/cli#10078
-   Print policy information before verifying attestations by [@&#8203;malancas](https://github.com/malancas) in cli/cli#9891
-   Improve error handling in apt setup script by [@&#8203;jobegrabber](https://github.com/jobegrabber) in cli/cli#10055
-   Use Windows compatible file name for downloaded attestations when running `gh attestation download` by [@&#8203;malancas](https://github.com/malancas) in cli/cli#10051
-   Bump github.com/cpuguy83/go-md2man/v2 from 2.0.5 to 2.0.6 by [@&#8203;dependabot](https://github.com/dependabot) in cli/cli#10094
-   Perform all `gh attestation verify` policy options configuration in the `newEnforcementCriteria()` function by [@&#8203;malancas](https://github.com/malancas) in cli/cli#10012

#### New Contributors

-   [@&#8203;ankddev](https://github.com/ankddev) made their first contribution in cli/cli#10025
-   [@&#8203;uday-rana](https://github.com/uday-rana) made their first contribution in cli/cli#10043
-   [@&#8203;jobegrabber](https://github.com/jobegrabber) made their first contribution in cli/cli#10055

**Full Changelog**: cli/cli@v2.63.2...v2.64.0

</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.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box

---

This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS43Ny4wIiwidXBkYXRlZEluVmVyIjoiMzkuNzcuMCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiUmVub3ZhdGUgQm90Il19-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

external pull request originating outside of the CLI core team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants