GitHub 連携
目的
FlowHub は GitHub Issues / Projects を候補者管理の基盤として利用します。GitHub 連携はその前提となる設定です。
前提条件
- GitHub 組織の Owner 権限 が必要です(初回の連携・自動セットアップ)。
- 連携時に GitHub App をインストールし、必要な権限を承認します。
GitHub App のインストールについて
注記
- FlowHub は GitHub App を組織にインストールして連携します。
- インストール時に権限の承認が必要で、Owner のみ実行できます。
- 組織の設定や承認フローによって、完了までに時間がかかることがあります。
- 権限不足やインストール先の選択ミスがある場合は、オンボーディングの案内に従って再実行してください。
要求される権限と理由
GitHub 連携では、GitHub アカウントの認可(OAuth)と GitHub App インストール時に権限の承認が必要です。表示される権限は次の用途に対応しています。
- read:org: Organization 一覧の取得と Owner 権限の確認に必要です。
- repo: 候補者管理用リポジトリの作成、Issue テンプレート/README の配置、Issue 操作に必要です。
- project: GitHub Projects (v2) の作成、フィールド設定、ステータス同期に必要です。
- workflow: 自動連携に使う GitHub Actions のシークレット登録に必要です。
ヒント
GitHub 組織の Base permissions は「No permission」が推奨です(FlowHub は連携状態の確認時に警告を表示します)。
連携時に作成されるもの
- 候補者管理用の GitHub リポジトリ
- 候補者の進捗を管理する GitHub Projects
- 候補者追加用の Issue テンプレート
- 候補者管理用リポジトリの README
注意
GitHub 上に同名のリポジトリ / Projects がある場合は作成できません。名称を変更するか、GitHub 側で削除/リネームして再チェックしてください。
同期対象
- 候補者 Issue(内容、コメント)
- Projects のステータス更新
画面での操作
- オンボーディング: GitHub 連携を開始し、GitHub App のインストールと権限の承認を行います。
- ワークスペース設定(一般): GitHub 連携の状態を確認します。
失敗時の挙動
警告
- 権限不足や承認の失敗がある場合、連携は完了しません。
- 連携が失敗した場合は、再認可の案内に従って再実行します。
利用できるロール
- Owner / 管理者