⑥ Ruleset 一括作成
指定 Repository に対して、設定ファイルで定義した Branch Ruleset を一括作成します。 既存 Ruleset と同名の Ruleset が存在する場合はスキップします。
✅ 前提
この Workflow を実行する前に、クイックスタートを完了してください。
📖 使い方
Actionsタブを開く⑥ Ruleset 一括作成を選択Run workflowをクリック- パラメータを入力して実行
⚙️ パラメータ
| パラメータ | 説明 | 必須 | タイプ | 例 |
|---|---|---|---|---|
target_repo |
対象 Repository(owner/repo 形式) | ✅ | string |
myorg/myrepo |
Note: 既存 Ruleset と同名の Ruleset が存在する場合はスキップされます。定義ファイルに含まれない既存 Ruleset は削除されません。追加のみの安全設計です。
📊 処理フロー
flowchart TD
A["workflow_dispatch\n(target_repo)"] --> B["setup-repository-rulesets Job\nRuleset定義ファイルを読み込み\n対象RepositoryにRulesetを一括作成"]
B --> C{"結果判定"}
C -- "成功" --> D["workflow-summary-success Job\n成功サマリーを出力"]
C -- "失敗" --> E["workflow-summary-failure Job\n失敗サマリーを出力"]
🔧 Workflow 仕様
ファイル
.github/workflows/06-setup-repository-rulesets.yml
トリガー
workflow_dispatch(手動実行)
環境変数
| 環境変数 | ソース | 説明 |
|---|---|---|
GH_TOKEN |
secrets.PROJECT_PAT |
GitHub PAT(Classic: repo Scope 必須 / Fine-grained: 対象リポジトリの Administration 権限が必要) |
TARGET_REPO |
inputs.target_repo |
対象 Repository |
PROJECT_PAT |
secrets.PROJECT_PAT |
PAT 形式検証用(ghp_ または github_pat_ で始まるか検証) |
Note:
PROJECT_PATが未設定または無効な形式の場合、 PAT を使用するステップはスキップされます。使用する PAT は Classic の場合repoScope、Fine-grained の場合は対象リポジトリの Administration 権限を付与してください。
Job 構成
.github/workflows/06-setup-repository-rulesets.yml
├── setup-repository-rulesets Job
│ └── scripts/setup-repository-rulesets.sh # Ruleset 一括作成
├── workflow-summary-failure Job(失敗時)
│ └── .github/actions/workflow-summary # 失敗サマリー出力
└── workflow-summary-success Job(成功時)
└── .github/actions/workflow-summary # 成功サマリー出力
📜 関連スクリプト
- setup-repository-rulesets.sh — Ruleset 一括作成スクリプト