はじめる

インストール

GitHub CLI 経由(推奨)

gh extension install myzkey/gh-repo-settings

アップグレード

gh extension upgrade myzkey/gh-repo-settings

手動インストール

Releases から最新のバイナリをダウンロードし、PATH に追加してください。

クイックスタート

# 対話形式で設定ファイルを作成
gh repo-settings init

# 変更をプレビュー(terraform plan のように)
gh repo-settings plan

# 変更を適用
gh repo-settings apply

デフォルトの設定ファイルパス(優先順):

  1. .github/repo-settings/(ディレクトリ)
  2. .github/repo-settings.yaml(単一ファイル)

基本設定

.github/repo-settings.yaml を作成:

repo:
  description: "素晴らしいプロジェクト"
  visibility: public
  allow_merge_commit: false
  allow_rebase_merge: true
  allow_squash_merge: true
  delete_branch_on_merge: true

topics:
  - typescript
  - cli
  - github

labels:
  items:
    - name: bug
      color: ff0000
      description: 不具合報告
    - name: feature
      color: 0e8a16
      description: 新機能リクエスト

branch_protection:
  main:
    required_reviews: 1
    dismiss_stale_reviews: true
    require_status_checks: true
    status_checks:
      - ci/test
      - ci/lint

次のステップ