https://github.com/jguadagno/github-branch-renamer
A Powershell script that renames the default branch for all of your public and private repositories
https://github.com/jguadagno/github-branch-renamer
Last synced: 2 months ago
JSON representation
A Powershell script that renames the default branch for all of your public and private repositories
- Host: GitHub
- URL: https://github.com/jguadagno/github-branch-renamer
- Owner: jguadagno
- Created: 2020-06-19T15:56:08.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2020-06-20T12:28:47.000Z (almost 5 years ago)
- Last Synced: 2024-10-19T01:18:09.042Z (7 months ago)
- Language: PowerShell
- Size: 2.93 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# GitHub Branch Rename
This is a small utility that I put together to '*rename*' branches in your GitHub repositories. Rename is *italicized* because it technically does not rename but creates a new branch, then sets that branch to be the repository default, then deletes the old branch. This script runs using the GitHub API only. There is no need to clone your repositories or even know their names.
It will rename branches from your public and private repositories that are not forks and have the default branch set to the `FromBranch` argument. When you are done running the script, if you have a copy of the repository locally, you will need to run the following commands in that repositories folder.
```bash
git pull
git checkout newBranchName # replace newBranchName with your new name
```
**Note** There has been limited testing on this. Use at your own risk!
## Running It
In order to run the script you will need [Powershell Core](https://docs.microsoft.com/en-us/powershell/scripting/overview?view=powershell-7) and a GitHub [Personal Access Token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). The token should need the following scopes:
* repo
* public_repo
I don't think it needs any other scopes.
From Powershell
```powershell
Rename-GitHub-Branches -GitHubToken "" -User "" -FromBranch "" -ToBranch ""
```
Optionally change the API Endpoint for Enterprise repositories
```powershell
Rename-GitHub-Branches -GitHubToken "" -User "" -FromBranch "" -ToBranch "" -ApiRootUri ""
```
Replace the following:
Argument | Description | Sample
--- | --- | ---
`` | Your GitHub personal access token | `abc123`
`` | Your GitHub user id | `jguadagno`
`` | The name for the new branch | `main`
`` | The api url (defaults to `https://api.github.com`) | `https://www.yourdomain.com/api/v3/`
## Want to Contribute
See something that I can approve? PR accepted :smile: