PAT の概要
Kody が自動コードレビューを実行できるようにするには、GitLab で個人用アクセストークン(PAT)を生成する必要があります。このトークンにより、Kody はリポジトリに安全にアクセスし、制御された方法でコード分析を実行できます。 Kody は、トークンの所有者である GitLab ユーザーとしてレビューを投稿します。個人用アクセストークンを使うと、OAuth で接続した場合と同じく、レビューはあなた自身のアカウントで表示されます。別のボットユーザーとして表示させるには、以下で説明するグループアクセストークンを使用してください。PAT(個人用アクセストークン)の生成
トークンを正しく設定するには、以下の手順に従ってください:- GitLab にアクセスし、プロフィール設定に移動します:
-
Access Tokensに移動します:- 左サイドバーで下にスクロールして
Access Tokensを見つけてクリックします。
- 左サイドバーで下にスクロールして
-
新しいトークンを追加します:
Add new tokenボタンをクリックします。
-
以下の仕様で新しいトークンを設定します:
- トークン名:
kody_code_reviewなど識別しやすい名前を選択します。 - 有効期限:可能であれば、少なくとも 180 日以上の長い有効期限を選択します。
- 権限:以下の権限を設定します:
- api
- read_api
- read_user
- read_repository
- write_repository
- トークン名:
-
トークンを確定して保存します:
- 権限を設定したら、
Generate tokenをクリックします。 - 生成されたトークンをコピーして安全に保存してください。Kody の設定に必要になります。
- 権限を設定したら、
グループアクセストークンの使用
グループアクセストークンを使うと、GitLab がそのトークン用に作成するボットユーザー(トークンと同じ名前)としてレビューが投稿されます。ボットは、グループとそのサブグループ内のすべてのプロジェクトにアクセスできます。GitLab.com では、グループアクセストークンには Premium または Ultimate のサブスクリプションが必要で、トライアル期間中は利用できません。GitLab Self-Managed と GitLab Dedicated では、どのライセンスでも利用できます。
-
グループのアクセストークン設定を開きます:
- GitLab で、リポジトリを含むグループを開き、
Settings>Access tokensに移動します。
- GitLab で、リポジトリを含むグループを開き、
-
新しいトークンを追加します:
Add new tokenボタンをクリックします。
-
以下の仕様で新しいトークンを設定します:
- トークン名:Kody のレビューに表示される名前です。例:
Kody。 - 有効期限:可能であれば、少なくとも 180 日以上の長い有効期限を選択します。
- ロール:
Maintainer。Kody は各プロジェクトに Webhook を作成するためにこのロールを必要とします。 - スコープ:
apiとread_repository。Kody はリポジトリをクローンしますが、グループアクセストークンのapiには Git over HTTPS が含まれません。
- トークン名:Kody のレビューに表示される名前です。例:
-
トークンを確定して保存します:
Create group access tokenをクリックします。- トークンをコピーして安全に保存してください。GitLab はトークンを一度しか表示しません。
Kody へのトークンの追加
トークンを生成した後、Kodus に貼り付けます:- オンボーディング中:Connect your Git tool で Gitlab タブを選び、Connect via token をクリックします。
- 後から:サイドバーで Repositories を開き、Connect a provider の下の Gitlab をクリックし、Token タブに切り替えてトークンを貼り付け、Validate and save をクリックします。セルフマネージドの GitLab の場合は、Self-hosted をオンにして Gitlab URL を入力します。
- トークンの差し替え:Repositories で Gitlab カードの Update token をクリックし、新しいトークンを貼り付けて Update token をクリックします。Webhook と選択済みのリポジトリはそのまま保持されます。
- OAuth からの切り替え:OAuth で作成した接続には Update token は表示されません。Reset をクリックして Just reset the integration を選択し、上記の手順でトークンを使って再接続してから、リポジトリを選択します。