Issue Queue
GitHub Issue の着手順・設計資料・着手状態を、サイドバーとCLIで管理する拡張です。
はじめに
Gitを開発環境へインストールしてください。
- 管理したいGitリポジトリをVS Codeで開きます。
- アクティビティバーの Issue Queue を開きます。
- 未初期化の場合は 初期化 を押します。
複数のフォルダーを開いている場合は、先頭のフォルダーを対象にします。非公開リポジトリのIssueを表示する際は、GitHubへのサインインを許可してください。
サイドバーの操作
- Issueをクリック:GitHub Pull Requests拡張でIssueの詳細を開きます。
- 上下ボタン:Issueの着手順を変更します。
- Issueを展開:登録された設計書などの資料を表示します。
- 資料をクリック:ファイルを開きます。登録先にない資料には警告が表示されます。
- 更新ボタン:表示を最新にします。
- 保存データを開く:キューの保存内容を確認します。
作業中のIssueには着手状態が表示されます。
CLIでIssueを追加する
コマンドパレットで Issue Queue: CLIターミナルを開く を実行し、対象のリポジトリ内で操作します。
issue-queue init
issue-queue add 143 156
issue-queue list
issue-queue document-add 143 docs/design.md
issue-queue claim-next --owner my-name
issue-queue claim-release 143
GitHubから次のIssueを取得する際、非公開リポジトリでは gh auth login または環境変数 GH_TOKEN / GITHUB_TOKEN でCLIを認証します。サイドバーでのサインインとは別の設定です。
全コマンドは issue-queue --help、バージョンは issue-queue --version で確認できます。CLIの結果はJSONで出力されます。
拡張の起動後に新しく作ったVS Codeターミナルでも issue-queue を使えます。既存のターミナルで見つからない場合は新しいターミナルを開いてください。WSL・SSH・Dev Containerでは、開発環境側へ拡張をインストールします。
AIエージェントや外部ターミナルから使う
コマンドパレットの Issue Queue: CLIのパスをコピー で、呼び出し先のパスを取得できます。VS Codeのターミナル以外から実行するAIエージェントには、このパスを設定してください。
CLIが起動できなくなった場合は、一度VS Codeを開き直してください。
保存データ
キューはmain worktreeの .issue-queue/queue.json に保存され、linked worktreeからも同じキューを使います。
資料の登録解除やIssueの削除で、資料ファイル自体が消えることはありません。作業中の状態は claim-release で解除するまで残ります。GitHubでCLOSEDになったIssueは cleanup-closed でキューから削除できます。