GHRC is a tool for managing GitHub Repository Configurations in a declarative way.
Repository configuration includes
$ go get github.com/shotat/ghrc
GHRC_GITHUB_TOKEN (Required)
repo scope is requiredGHRC_GITHUB_API (Optional)
https://api.github.com/https://<domain>/api/v3/# ghrc import <repository full name>
$ ghrc import shotat/ghrc > .ghrc.yaml
$ ghrc plan
This command reads .ghrc.yaml file implicitly.
You can specify a config file explicitly with -f.
$ ghrc plan -f .ghrc.yaml
If --name option is specified, metadata.name is overridden.
$ ghrc plan --name shotat/rbdash
$ ghrc plan
~ Repo: shotat/ghrc
{*state.Repo}.Description:
-: "GHRC is a tool for managing GitHub Repository Configurations in a declarative way."
+: "GHRC is an awesome tool for managing GitHub Repository Configurations in a declarative way."
{*state.Repo}.AllowRebaseMerge:
-: false
+: true
Sort({*state.Repo}.Topics)[1->?]:
-: "git"
+: <non-existent>
+ Label: awesome
{*state.Label}:
-: (*state.Label)(nil)
+: &state.Label{Name: "awesome", Description: "Awesome issue", Color: "d73a4b"}
~ Label: bug
{*state.Label}.Color:
-: "d73a4a"
+: "d73a4b"
~ Label: documentation
~ Label: review
- Label: question
{*state.Label}:
-: &state.Label{Name: "question", Description: "Further information is requested", Color: "d876e3"}
+: (*state.Label)(nil)
~ Protection: master
{*state.Protection}.RequiredStatusChecks.Strict:
-: false
+: true
{*state.Protection}.RequiredStatusChecks.Contexts[0->?]:
-: "ci/dockercloud"
+: <non-existent>
{*state.Protection}.RequiredPullRequestReviews.RequiredApprovingReviewCount:
-: 1
+: 2
$ ghrc apply
This command reads .ghrc.yaml file implicitly.
You can specify a config file explicitly with -f.
$ ghrc apply -f .ghrc.yaml
If --name option is specified, metadata.name is overridden.
$ ghrc apply --name shotat/rbdash
Root
| Field | Type | Description |
|---|---|---|
| metadata | Metadata Object | Provides metadata about the repository. If omitted, metadata.name must be specified by --name option instead. |
| spec | Spec Object | Required. A desired state for the repository. |
Metadata Object
| Field | Type | Description |
|---|---|---|
| name | string | A repository name (e.g. shotat/ghrc). If omitted, metadata.name must be specified by --name option instead. |
Spec Object
| Field | Type | Description |
|---|---|---|
| repo | Repo Object | General configurations for the repository. |
| labels | [Label Object] | List of label configurations. |
| protections | [Protection Object] | List ob protection configurations. |
Repo Object
Check details in GitHub API docs: Repositories
| Field | Type | Description |
|---|---|---|
| description | string | A short description of the repository. |
| homepage | string | A URL with more information about the repository. |
| private | boolean | Either true to make a repository private or false to make public. |
| allowMergeCommit | boolean | Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits. |
| allowSquashMerge | boolean | Either true to allow squash-merging pull requests, or false to prevent squash-merging. |
| allowRebaseMerge | boolean | Either true to allow rebase-merging pull requests, or false to prevent rebase-merging. |
| topics | [string] | An array of topics. Note: Topic names cannot contain uppercase letters. |
NOTE: Each field is not managed by GHRC when omitted or specified to null
Label Object
Check details in GitHub API docs: Labels
| Field | Type | Description |
|---|---|---|
| name | string | The name of the label. |
| description | string | A short description of the label. |
| color | string | The hexadecimal color code for the label, without the leading #. |
Protection Object
Check details in GitHub API docs: Branches
| Field | Type | Description |
|---|---|---|
| branch | string | A branch name to be protected. |
| enforceAdmins | boolean | Enforce all configured restrictions for administrators. |
| requiredStatusChecks | RequiredStatusChecks Object | Require status checks to pass before merging. |
| requiredPullRequestReviews | RequiredPullRequestReviews Object | Require at least one approving review on a pull request, before merging. |
RequiredStatusChecks Object
| Field | Type | Description |
|---|---|---|
| strict | boolean | Require branches to be up to date before merging. |
| contexts | [string] | The list of status checks to require in order to merge into this branch. |
RequiredPullRequestReviews Object
| Field | Type | Description |
|---|---|---|
| dismissStaleReviews | boolean | Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit. |
| requireCodeOwnerReviews | boolean | Blocks merging pull requests until code owners review them. |
| requiredApprovingReviewCount | int | Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6. |
metadata:
name: shotat/ghrc
spec:
repo:
description: GHRC is a tool for managing GitHub Repository Configurations in a declarative way.
homepage: "https://github.com/shotat/ghrc"
private: false
allowMergeCommit: false
allowSquashMerge: true
allowRebaseMerge: false
topics:
- cli
- git
- github
- go
labels:
- name: bug
description: Something isn't working
color: d73a4a
- name: documentation
description: Improvements or additions to documentation
color: 0075ca
- name: question
description: Further information is requested
color: d876e3
- name: review
description: "ready for review"
color: f0f0f0
protections:
- branch: master
requiredStatusChecks:
strict: false
contexts:
- ci/dockercloud
enforceAdmins: false
requiredPullRequestReviews:
dismissStaleReviews: false
requireCodeOwnerReviews: false
requiredApprovingReviewCount: 1
Content type
Image
Digest
Size
9.1 MB
Last updated
almost 7 years ago
docker pull shotat/ghrc