Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MadJlzz/octoherd-script-organization-setup
Simple script to bootstrap a GitHub organization configuration.
https://github.com/MadJlzz/octoherd-script-organization-setup
octoherd-script
Last synced: 3 months ago
JSON representation
Simple script to bootstrap a GitHub organization configuration.
- Host: GitHub
- URL: https://github.com/MadJlzz/octoherd-script-organization-setup
- Owner: MadJlzz
- Archived: true
- Created: 2021-10-11T21:42:21.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2021-10-19T00:02:08.000Z (about 3 years ago)
- Last Synced: 2024-04-08T02:55:35.030Z (7 months ago)
- Topics: octoherd-script
- Language: JavaScript
- Homepage:
- Size: 28.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-octoherd-scripts - Organization setup - Configure default settings for a repositories within an organization. (Scripts)
README
# octoherd-script-organization-setup
> This script configure default settings for a repositories within an organization.
## Usage
Minimal usage
```bash
npx octoherd-script-organization-setup \
--template MadJlzz/octoherd-template
```
Pass all options as CLI flags to avoid user prompts
```bash
npx octoherd-script-organization-setup \
--template MadJlzz/octoherd-template \
-T ghp_0123456789abcdefghjklmnopqrstuvwxyzA \
-R "MadJlzz/*"
```
## Options
| option | type | description |
| ------------------------------ | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--template` | string | **(required)** this is the repo you want the settings to be copied from |
| `--copy-labels` | boolean | **(optional)** a flag used to trigger label copying |
| `--copy-merge-options` | boolean | **(optional)** a flag used to trigger merge options strategy copying |
| `--copy-default-branch-option` | boolean | **(optional)** a flag used to trigger default branch option copying |
| `--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.