https://github.com/octoherd/script-rename-master-branch-to-main

Renames the default branch to main if it is currently set to master
https://github.com/octoherd/script-rename-master-branch-to-main

octoherd-script

Last synced: 3 months ago
JSON representation

Renames the default branch to main if it is currently set to master

• Host: GitHub
• URL: https://github.com/octoherd/script-rename-master-branch-to-main
• Owner: octoherd
• License: isc
• Created: 2021-05-06T00:10:30.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-30T09:04:54.000Z (3 months ago)
• Last Synced: 2024-07-30T12:16:06.505Z (3 months ago)
• Topics: octoherd-script
• Language: JavaScript
• Size: 95.7 KB
• Stars: 14
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-octoherd-scripts - Rename master branch to main - Renames the default branch to main if it is currently set to master. (Scripts)

README

        
# script-rename-master-branch-to-main

> Renames the default branch to main if it is currently set to master

[![@latest](https://img.shields.io/npm/v/@octoherd/script-rename-master-branch-to-main.svg)](https://www.npmjs.com/package/@octoherd/script-rename-master-branch-to-main)

[![Build Status](https://github.com/octoherd/script-rename-master-branch-to-main/workflows/Test/badge.svg)](https://github.com/octoherd/script-rename-master-branch-to-main/actions?query=workflow%3ATest+branch%3Amain)

## Usage

Note: Your GitHub account must have owner or admin permission in order to rename the default branch on a repository

Minimal usage

```js

npx @octoherd/script-rename-master-branch-to-main

```

Pass all options as CLI flags to avoid user prompts

```js

npx @octoherd/script-rename-master-branch-to-main \

  -T ghp_0123456789abcdefghjklmnopqrstuvwxyzA \

  -R "octoherd/*"

```

## Options

| option                       | type             | description                                                                                                                                                                                                                                 |

| ---------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

| `--octoherd-token`, `-T`     | string           | A personal access token ([create](https://github.com/settings/tokens/new?scopes=repo)). Script will create one if option is not set                                                                                                         |

| `--octoherd-repos`, `-R`     | array of strings | One or multiple space-separated repositories in the form of `repo-owner/repo-name`. `repo-owner/*` will find all repositories for one owner. `*` will find all repositories the user has access to. Will prompt for repositories if not set |

| `--octoherd-bypass-confirms` | boolean          | Bypass prompts to confirm mutating requests                                                                                                                                                                                                 |

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md)

## About Octoherd

[@octoherd](https://github.com/octoherd/) is project to help you keep your GitHub repositories in line.

## License

[ISC](LICENSE.md)