GitHubは、Coroidを通じて接続します。GitHubアプリまたはパーソナルアクセストークン。設定はこちらで行います。設定 → 接続 → ソースコントロール。
アプリまたはトークン
アプリを利用することを推奨します。アプリはユーザー単位ではなくリポジトリ単位でアクセス権を付与し、設定者が退職しても動作し続け、ポーリングなしでWebhookイベントを受信できます。
アプリのインストールに組織管理者の承認が必要で取得できない場合は、トークンを使用してください。
| GitHubアプリ | パーソナルアクセストークン | |
|---|---|---|
| アクセス範囲 | リポジトリごと | ユーザーが閲覧可能なすべての内容 |
| インストーラーの退職後も有効 | はい | いいえ |
| Webhookイベント | はい | ポーリング |
| 帰属 | アプリ | トークンの所有者 |
アプリのインストール
GitHubを選択して、設定 → 接続 → ソースコントロールでインストール手順に従ってください。GitHubはどのリポジトリにアクセス権を付与するかを尋ねてきます。後からGitHubの設定画面で変更することも可能です。
プロジェクト作成時にリポジトリが表示されない場合、ほぼ確実にその特定のリポジトリへのアクセス権がアプリに付与されていないことが原因です。これが最も一般的な原因です。
トークンの使用
「読み取り」スコープを持つクラシックトークンを作成するか、repoコンテンツおよびプルリクエストに対する読み取り・書き込み権限を持つ細粒度トークンを作成し、ソースコントロールの設定に貼り付けてください。
トークンは保存時には暗号化され、APIから返却されることはなく、設定のエクスポートにも含まれません。
GitHubイシュー
同じ接続を使ってイシューを作業としてインポートできます。詳細はこちらを参照してください。作業のインポート。
作業となるイベント
アプリを使用すると、イベント自動化機能がpull request、新しいイシュー、またはQualificationに送信されるCoroidを言及するコメントを生成できます。詳細はこちらを参照してください。トリガーと送信先。
これらのイベントから生成された作業が自動的に開始されるのは、作成者がリポジトリに対して書き込み・保守・管理者権限を持つ場合のみです。Coroidは各イベントについてGitHubに問い合わせます。pull requestの場合、作成者はそれを開いた人ではなく、ラベル付けやマージを行った人となります。他のユーザーが作成した作業は作成されてから誰かが開始するのを待ちます。Coroidを言及するコメントは、作成者に書き込み権限がある場合にのみ有効です。
プルリクエストのレビュー
アプリを使用すると、Coroidは自分で作成したプルリクエストだけでなく、他のユーザーやツールが開いたプルリクエストもチェック・レビューします。Coroid品質管理機能がプロジェクトのチェックを実行し、Coroid品質管理チェックを投稿します。Coroidレビュー機能は問題のある行にコメントを付けたレビューを投稿し、Coroidレビューという名前のチェックも作成します。これらはすべて品質管理の「プルリクエスト」セクションで設定できます。詳細はこちらを参照してください。プルリクエスト。
Coroidがリポジトリ内で行う作業
- コードを読み取って理解し、変更を加える
- タスクごとにブランチを作成する
- そのブランチをプッシュし、ベースブランチに対してpull requestを開く
GitHubは決してデフォルトブランチにコミットしたり、自動でマージしたりしません。マージが行われるのは、GitHub内でpull requestをマージするか、「承認してマージCoroidで。
「ローカルのみ」に設定されたプロジェクトは、上記の最初の処理のみを行い、それ以上の作業は行いません：Coroidはコードを読み取ってプルし、ブランチ・レビュー・チェックをCoroid内に保持します。アプリやトークンで許可されていても、プルリクエストのプッシュ・開設・コメント投稿、チェック実行は行いません。詳細はこちらを参照してください。同期またはローカルのみ。
ブランチ保護設定、必須チェック、レビュールールは従来通り適用されます。承認してマージもpull requestを通じてマージされるため、成功可否は同じルールで判断されます。詳細はこちらを参照してください。マージ。