ドキュメント

GitHub

GitHubをAppまたは個人用アクセストークンと接続し、それぞれが付与する権限の違いを確認しましょう。

GitHubはCoroidを介して接続しますGitHub Appまたは個人用アクセストークン。設定は設定 → 接続 → ソースコントロール.

Appまたはトークン

Appを利用することを推奨します。Appではユーザー単位ではなくリポジトリ単位でアクセス権が付与され、設定者が退職しても機能し続け、ポーリングなしでWebhookイベントを受信できます。

Appのインストールに組織管理者の承認が必要で、それが得られない場合にはトークンを使用してください。

GitHub App個人用アクセストークン
アクセス範囲リポジトリごとユーザーが閲覧可能なすべての内容
設定者が退職しても継続して動作はいいいえ
Webhookイベントはいポーリング
帰属関係Appトークンの所有者

アプリのインストール

GitHubを選択してください設定 → 接続 → ソースコントロールインストール手順に従ってください。GitHubが権限を付与するリポジトリを尋ねてきますが、後からGitHubの設定で変更することも可能です。

プロジェクト作成時にリポジトリが表示されない場合、その原因はほぼ確実に、当該アプリにその特定のリポジトリへのアクセス権が付与されていないことです。

トークンの利用方法

「読み取り」スコープを持つクラシックなトークンを作成するか、repoコンテンツおよびプルリクエストに対する読み取り・書き込み権限を持つ細粒度トークンを作成し、それをソースコントロールの設定に貼り付けてください。

トークンは保存時には暗号化され、APIから返却されることはなく、設定のエクスポートにも含まれません。

GitHubの課題

同じ接続を利用して課題を作業内容としてインポートできます。詳細は以下をご覧ください。作業内容のインポート方法.

Coroidがリポジトリ内で行う処理

  • コードを読み取って理解し、変更を加えます
  • タスクごとにブランチを作成します
  • そのブランチをプッシュし、ベースブランチに対してpull requestを開設します

デフォルトブランチへのコミットやマージは一切行いません。ブランチ保護設定、必須チェック、レビュールールは従来通り適用されます。