メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://docs.kodus.io/llms.txt

Use this file to discover all available pages before exploring further.

はじめに

Kody が Bitbucket Cloud で自動コードレビューを実行できるようにするには、API トークンを生成する必要があります。このトークンにより、Kody は以下に記載された特定の権限で、リポジトリ、プルリクエスト、Webhook、イシュー、パイプラインなどにアクセスできます。

Bitbucket での API トークンの生成

  1. Atlassian API トークンページを直接開きます(または、Atlassian プロフィールから Security → API tokens に移動します)。
  2. Create API token with scopes をクリックします。
  3. トークンに名前(例:kody_code_review)を付け、有効期限を設定します。
  4. プロンプトが表示された場合は、アプリケーションとして Bitbucket を選択します。
  5. 必要なスコープをすべて選択します(以下参照)。
  6. 選択内容を確認し、Create token をクリックします。
  7. トークンをすぐにコピーして安全に保存してください — 作成後に再度表示することはできません。

Kody に必要なスコープ

Kody との完全な機能のために、トークンには以下のすべてのスコープが含まれている必要があります:
スコープ目的 / 有効にするもの
read:user:bitbucketユーザーまたはアカウントの基本情報を読み取る。
read:workspace:bitbucketワークスペースに関する情報(プロジェクト、メンバー、リポジトリ)を読み取る。
read:project:bitbucketプロジェクトのメタデータを読み取る。
read:repository:bitbucketリポジトリのコード、ブランチ、ソースファイルを読み取る。
write:repository:bitbucket必要に応じてリポジトリのコンテンツを変更する(コメント、ファイルの更新など)。
admin:repository:bitbucketリポジトリの管理操作:Webhook の管理、権限、リポジトリ設定。
read:pullrequest:bitbucketプルリクエスト、そのステータス、コメントを表示する。
write:pullrequest:bitbucketプルリクエストのコメントを作成または変更し、PR を承認、拒否、またはマージする。
read:issue:bitbucketイシュートラッカー情報を読み取る。
read:webhook:bitbucket既存の Webhook とその設定を表示する。
write:webhook:bitbucketWebhook を作成または更新する。
read:pipeline:bitbucketリポジトリまたは PR に関連するパイプラインのステータス/ログを読み取る。
⚠️ 必要な権限のみを付与してください。セキュリティリスクを減らすために、必要以上の権限を付与しないでください。

Kody へのトークンの追加

  • 必要なすべてのスコープでトークンが生成されたら、Bitbucket 統合を有効にする際に Kody 統合 / 自動化設定画面に貼り付けます。
  • Kody が Webhook を設定したりプルリクエストイベントをリッスンする必要がある場合は、トークンに admin:repository:bitbucket(または同等のもの)があることを確認してください。

重要な注意事項

  • トークンは作成時に一度だけ表示されます。安全に保存してください。再度表示することはできません
  • トークンの有効期間を制限するために、可能であれば有効期限を設定してください。
  • トークンが侵害された場合は、すぐに失効させて新しいトークンを作成してください。
  • トークンとそのスコープを定期的に監査し、まだ必要で有効であることを確認してください。
  • Bitbucket のプラン/アカウントが上記のすべてのスコープを許可しているか確認してください。一部のスコープ(プロジェクト、ワークスペース、管理者)はサブスクリプション/権限に依存する場合があります。