📖 GitHub Projects Ops Kit ドキュメント
GitHub Projects の「立ち上げ」と「運用」を、まるごと自動化。
GitHub Projects Ops Kit は、GitHub Projects の運用立ち上げと継続運用を支援するツールキットです。 Project の作成、Field・Status・View の一括セットアップ、Issue/PR の紐付け、滞留検知、各種レポート生成までを GitHub Actions の Workflow 実行だけで完結させます。 JSON 定義ファイルで構成を管理するため、何度でも同じ環境を再現でき、チーム内での標準化にも活用できます。
（ここをクリック）目次
🧭 あなたの状況に合わせて始める
GitHub Projects Ops Kit は、個人開発者から Organization 管理者まで、さまざまな立場・フェーズの方にお使いいただけます。 自分に近い状況を選んで、最適なページへ進んでください。
🧑💻 個人開発者・ソロメンテナーの方
初期設定が面倒で後回しにしていた GitHub Projects を、すぐに使い始めたい方向け。
- Fork して Workflow を実行するだけ。約 1 分でセットアップ完了
- 複数の個人リポジトリを 1 つの Project で一元管理できます
| 次のステップ | リンク |
|---|---|
| 活用ガイドを読む | 個人開発者・ソロメンテナー向けガイド |
| すぐに始める（GUI） | GUI クイックスタート |
| すぐに始める（CLI） | CLI クイックスタート |
🤝 OSS メンテナー・小規模チームの方
コントリビュータが増えてきて、運用ルールの統一や Issue/PR 管理の標準化が課題になっている方向け。
- JSON 定義ファイルで構成をコード管理し、誰が Project を作っても同じ構成を再現
- Label も一括設定。チーム全員が同じ画面で作業できます
| 次のステップ | リンク |
|---|---|
| 活用ガイドを読む | OSS メンテナー・小規模チーム向けガイド |
| すぐに始める（GUI） | GUI クイックスタート |
| すぐに始める（CLI） | CLI クイックスタート |
🏢 Organization 管理者・PM・EM の方
複数チーム・リポジトリの横断管理、レポート自動生成、運用の標準化と定着を実現したい方向け。
- レポート自動生成で定例報告の準備時間を大幅削減
- 外部ツール不要。GitHub だけで運用基盤を構築できます
| 次のステップ | リンク |
|---|---|
| 活用ガイドを読む | Organization 管理者・PM・EM 向けガイド |
| すぐに始める（GUI） | GUI クイックスタート |
| すぐに始める（CLI） | CLI クイックスタート |
🚀 はじめての方へ
GitHub Projects を使ったプロジェクト管理をすぐに始められます。以下のステップで進めてください。
flowchart LR
A["1. Fork"] --> B["2. PAT 作成"]
B --> C["3. Secrets 設定"]
C --> D["4. Actions 有効化"]
D --> E["5. Workflow 実行"]
🖱️ GUI で進める方（おすすめ）
GitHub の画面操作だけでセットアップできます。コマンド操作は不要です。
⌨️ CLI で進める方（上級者向け）
gh CLI を使ってターミナルから操作します。生成 AI へのヒントとしても活用できます。
📋 やりたいこと別ガイド
🏗️ 構築する
| やりたいこと | Workflow | 説明 |
|---|---|---|
| 新しく Project を作りたい | ① GitHub Project 新規作成 | Project の作成 & Field・Status・View を一括セットアップ |
| 既存の Project を整えたい | ② GitHub Project 拡張 | 既存 Project に Field・Status・View を追加 |
| 特殊 Repository を一括作成したい | ③ 特殊 Repository 一括作成 | プロフィール README・GitHub Pages・dotfiles 等の特殊 Repository を一括作成 |
| Repository に Issue Label を一括追加したい | ④ Issue Label 一括追加 | 設定ファイルで定義した Issue Label を Repository に一括作成 |
| Issue/PR をまとめて取り込みたい | ⑤ Issue/PR 一括紐付け | Project に Repository の Issue/PR を一括追加 |
📈 分析・レポートする
| やりたいこと | Workflow / スクリプト | 説明 |
|---|---|---|
| Project の内容を一覧で出したい | ⑥ 統合 Project 分析 | Project の Issue/PR 一覧をエクスポート（report_types: export） |
| 滞留タスクを検知したい | ⑥ 統合 Project 分析 | 指定日数以上動きのないアイテムを自動検出（report_types: stale） |
| サマリーレポートを出したい | ⑥ 統合 Project 分析 | Status 別・担当者別の集計レポートを生成（report_types: summary） |
| 工数・ベロシティを把握したい | ⑥ 統合 Project 分析 | 工数集計・ベロシティレポートを生成（report_types: effort,velocity） |
🗂️ このドキュメントの構成
Docs サイトは以下のカテゴリで構成されています。目的に応じて各カテゴリを参照してください。
| カテゴリ | 内容 | 対象 |
|---|---|---|
| はじめに | Fork〜Workflow 実行までのクイックスタート | 初めて使う方 |
| ユースケース | 個人・OSS チーム・Organization 向けの活用ガイド | 導入検討中の方 |
| Workflow リファレンス | 各 Workflow の入力値・動作・出力の詳細 | 導入後に Workflow を使う方 |
| 運用ガイド | カンバンルール・Label 運用・認証設定 | 運用を整えたい方 |
| スクリプトリファレンス | 各スクリプトの仕様・パラメータ | カスタマイズしたい方・開発者 |
| FAQ・トラブルシューティング | よくある質問とエラー対応 | 困ったときに |
| 開発者向け | 内部構成・コントリビューション情報 | 開発に参加したい方 |
| About | 運営元 Lurest・開発者 mabubu0203 の紹介 | プロジェクトの背景を知りたい方 |
📚 詳しく知りたい方へ
| トピック | 説明 |
|---|---|
| 認証・トークンガイド | PAT の権限設定、Fine-grained / Classic token の選び方 |
| 入力値ガイド | project_number・target_repo などの確認方法 |
| 運用ルール | カンバンフロー、カスタム Field、View 構成 |
| Label 運用ルール | Issue Label のカテゴリ分類、用途、付与タイミング |
| Artifact の手動削除 | Workflow で生成された Artifact の削除手順（GUI / CLI） |
| 用語集 | GitHub 関連の専門用語の解説 |
📰 関連記事
| 記事 | 掲載先 |
|---|---|
| GitHub Projects の初期構築・運用分析を自動化する GitHub Actions ツールキット | Qiita |
🔧 困ったときは
| 状況 | 参照先 |
|---|---|
| エラーが出る・動かない | トラブルシューティング |
| よくある質問を確認したい | FAQ |
| バグを報告したい | バグ報告 |
🤝 コミュニティに参加する
| やりたいこと | 参照先 |
|---|---|
| 機能リクエストをしたい | 機能リクエスト |
| 質問したい | Q&A |
| アイデアを共有したい | Ideas |
| 雑談したい | General |
| 成果を共有したい | Show and tell |
| コントリビュートしたい | コントリビューションガイド |