gh-default-branch

GitHub CLI extension to show & rename the default branch.

rename subcommand was inspired by this gist.

⚠️ Caution

The rename subcommand is missing some features.

If you want any of the following missing features, try to change the default branch name from the GUI.

See. https://github.com/github/renaming#renaming-existing-branches

• Re-target any open pull requests
• Update any draft releases based on the branch
• Move any branch protection rules that explicitly reference the old name
• Update the branch used to build GitHub Pages, if applicable
• Show a notice to repository contributors, maintainers, and admins on the repository homepage with instructions to update local copies of the repository
• Show a notice to contributors who git push to the old branch
• Redirect web requests for the old branch name to the new branch name
• Return a "Moved Permanently" response in API requests for the old branch name

Also see. cli/cli#1215

Installation

$ gh extension install daido1976/gh-default-branch

Usage

# Show the default branch
$ gh default-branch show

# Show just the name of the default branch (e.g. main)
$ gh default-branch show -n # or --name-only

# Rename the default branch
$ gh default-branch rename <NAME>

Development

Debug

Debug with gh-default-branch script.

$ gh extension install .
$ gh default-branch <SUBCOMMAND>

Release

This extension is released as a precompiled extension.

$ git tag <version(e.g.`v0.1.0`)>
$ git push --tag