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

Qoder Action とは

Qoder Action は、標準的な GitHub Actions コンポーネントです。
Qoder CLI の強力な機能を GitHub ワークフローに統合し、Pull Request や Issue 上でのインテリジェントなコード協業を実現します。
シンプルな設定だけで GitHub Actions Runner 上で Qoder CLI を実行でき、
チームに すぐに使える 2 つの中核機能を提供します。
  • 自動 PR レビュー
  • @qoder によるインタラクティブなコラボレーション
👉 Qoder Action リポジトリを見る

主な特長

  • インテリジェントな PR 自動レビュー
    すべての Pull Request に対して包括的なコードレビューを自動実行します。
    コード不具合、セキュリティ脆弱性、テストカバレッジなどを検出し、マージ前にコード品質を向上させます。
  • @qoder がいつでも応答
    Issue や PR のコメントで @qoder をメンションするだけで、
    コードの解説、実装提案、あるいは直接的な修正を取得できます。
  • プロジェクトを深く理解
    プロジェクト固有のコーディング規約、アーキテクチャ、ビジネスロジックを尊重します。
  • 迅速なセットアップ
    数分で設定が完了し、すぐにチームの生産性を向上させます。
  • 安全・信頼性
    コードは GitHub Actions Runner 上で実行され、データセキュリティを確保します。

クイックスタート

方法 1:クイックセットアップ(推奨)

qodercli で以下のコマンドを実行し、ガイドに従って設定を完了してください。
/setup-github

方法 2:手動セットアップ

1. GitHub App のインストールとアクセストークン取得

  1. Qoder Integrations にアクセス
  2. Qoder アカウントと GitHub アカウントを連携し、
    対象リポジトリに qoderai GitHub App をインストール
  3. Qoder Personal Access Token を生成
注意
以前に qoderai をインストールしている場合は、
GitHub App のインストール一覧から 権限アップグレード要求がないか確認し、
必要な権限を付与してください。

2. リポジトリ Secrets にトークンを追加

リポジトリの
Settings → Secrets and variables → Actions
に以下を追加します。
  • KeyQODER_PERSONAL_ACCESS_TOKEN
  • Value:Qoder Personal Access Token

3. ワークフローの選択と追加

Qoder Action examples にアクセスし、要件に合ったワークフローを選択します。
選択した YAML をリポジトリの .github/workflows/ ディレクトリにコピーしてください。
  • Code Review
    Pull Request のコード品質、テストカバレッジ、セキュリティ問題を自動分析
  • Assistant
    Issue や PR 上でのインタラクティブ対話(@qoder)を有効化

4. 利用開始

  • Code Review
    新しい Pull Request を作成し、Qoder のレビュー結果を待ちます。
  • Assistant
    任意の Issue や PR に以下のようにコメントします。
    • @qoder このコードを説明して
    • @qoder この問題を修正して

ベストプラクティス

出力言語をカスタマイズする

prompt 内で出力言語を指定できます。
- name: Run Qoder Code Review
  uses: QoderAI/qoder-action@v0
  with:
    qoder_personal_access_token: ${{ secrets.QODER_PERSONAL_ACCESS_TOKEN }}
    prompt: |
      /review-pr
      REPO:${{ github.repository }} PR_NUMBER:${{ github.event.pull_request.number }}
      OUTPUT_LANGUAGE: Chinese

Agents.md でレビュー基準を定義する

リポジトリのルートに Agents.md を作成すると、
Qoder CLI はその内容を自動的にコンテキストとして読み込みます。
# プロジェクトのコードレビュー規約

## レビュー重点
- すべての DB クエリは必ずパラメータ化クエリを使用すること
- API は必ず認可チェックを行うこと
- 機密情報(パスワード、トークン)のハードコード・ログ出力は禁止
- 外部入力はすべて検証・サニタイズすること

## 無視してよいチェック
- テストファイル(`*.test.js`、`*.spec.ts`)の重複コード検出
- 自動生成ファイル(`generated/`、`dist/`)のスタイル警告
- Mock データファイルの複雑度警告

## チームルール
- `Promise.then()` ではなく `async/await` を使用
- コンポーネント名は PascalCase
- ユーティリティ関数は camelCase
- 定数は UPPER_SNAKE_CASE

PR サイズに応じてレビューをスキップする

大規模な PR では、コスト(credits)を抑えるために条件付きでレビューをスキップできます。
steps:
  - name: Check PR Size
    id: check_size
    run: |
      # PR の追加行数を取得
      LINES_CHANGED=$(jq .pull_request.additions < $GITHUB_EVENT_PATH)
      echo "変更行数: $LINES_CHANGED"

      # 500 行を超える場合はスキップ
      if [ "$LINES_CHANGED" -gt 500 ]; then
        echo "skip=true" >> $GITHUB_OUTPUT
      else
        echo "skip=false" >> $GITHUB_OUTPUT
      fi

  - uses: QoderAI/qoder-action@v0
    if: steps.check_size.outputs.skip == 'false'
    # ... その他の設定

より多くの設定例については、Recipes ドキュメントをご参照ください。
完全なサンプルやベストプラクティスを掲載しています。

技術サポート