project-init

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

project-init

project-init

GitHub Project v2 を新規作成し、標準フィールドを設定してリポジトリにリンクします。ビルトインワークフロー(自動ステータス変更・自動追加・自動アーカイブ)の設定もガイドします。
创建新的GitHub Project v2,设置标准字段并关联到仓库。同时引导配置内置工作流(自动状态变更、自动添加、自动归档)。

前提条件

前提条件

  • gh
    CLI がインストールされ、認証済みであること
  • project
    スコープが付与されていること(
    gh auth status
    で確認)
  • 已安装并认证
    gh
    CLI
  • 已授予
    project
    权限范围(可通过
    gh auth status
    确认)

フロー

流程

Step 1: プロジェクト情報を確認する

Step 1: 确认项目信息

ユーザーから以下を確認:
  • プロジェクトタイトル
  • オーナー(ユーザー or Organization)
  • 可視性(PUBLIC / PRIVATE)
  • 説明文(任意)
オーナーが未指定の場合は自動検出:
bash
gh repo view --json owner -q '.owner.login'
向用户确认以下信息:
  • 项目标题
  • 所有者(用户或组织)
  • 可见性(PUBLIC / PRIVATE)
  • 描述文本(可选)
若未指定所有者则自动检测:
bash
gh repo view --json owner -q '.owner.login'

Step 2: プロジェクトを作成する

Step 2: 创建项目

bash
gh project create \
  --owner <owner> \
  --title "<タイトル>" \
  --format json
出力からプロジェクト番号を取得する。
bash
gh project create \
  --owner <owner> \
  --title "<标题>" \
  --format json
从输出中获取项目编号。

Step 3: リポジトリにリンクする

Step 3: 关联到仓库

bash
gh project link <number> --owner <owner>
bash
gh project link <number> --owner <owner>

Step 4: 標準フィールドを作成する

Step 4: 创建标准字段

以下のフィールドを順次作成する:
bash
undefined
依次创建以下字段:
bash
undefined

Status(デフォルトで存在する場合はスキップ)

Status(若默认已存在则跳过)

gh project field-create <number>
--owner <owner>
--name "Status"
--data-type "SINGLE_SELECT"
--single-select-options "Todo,In Progress,In Review,Done"
gh project field-create <number>
--owner <owner>
--name "Status"
--data-type "SINGLE_SELECT"
--single-select-options "Todo,In Progress,In Review,Done"

Priority

Priority

gh project field-create <number>
--owner <owner>
--name "Priority"
--data-type "SINGLE_SELECT"
--single-select-options "High,Medium,Low"
gh project field-create <number>
--owner <owner>
--name "Priority"
--data-type "SINGLE_SELECT"
--single-select-options "High,Medium,Low"

Size

Size

gh project field-create <number>
--owner <owner>
--name "Size"
--data-type "SINGLE_SELECT"
--single-select-options "XS,S,M,L,XL"

> **Note:** Status フィールドは GitHub が自動作成する場合がある。エラーが出た場合は既存フィールドをそのまま使用する。
gh project field-create <number>
--owner <owner>
--name "Size"
--data-type "SINGLE_SELECT"
--single-select-options "XS,S,M,L,XL"

> **注意:** GitHub可能会自动创建Status字段。若出现错误则直接使用现有字段。

Step 5: プロジェクトの説明を設定する

Step 5: 设置项目描述

bash
gh project edit <number> \
  --owner <owner> \
  --description "<説明文>" \
  --visibility <PUBLIC|PRIVATE>
bash
gh project edit <number> \
  --owner <owner> \
  --description "<描述文本>" \
  --visibility <PUBLIC|PRIVATE>

Step 6: ビルトインワークフローを設定する

Step 6: 配置内置工作流

GitHub Projects v2 にはコード不要のビルトインワークフローがある。プロジェクト設定画面でユーザーに以下の有効化をガイドする。
設定 URL:
https://github.com/orgs/<owner>/projects/<number>/workflows
(個人プロジェクトの場合:
https://github.com/users/<owner>/projects/<number>/workflows
GitHub Projects v2提供无需代码的内置工作流。引导用户在项目设置页面启用以下选项。
设置 URL:
https://github.com/orgs/<owner>/projects/<number>/workflows
(个人项目时:
https://github.com/users/<owner>/projects/<number>/workflows

推奨するビルトインワークフロー

推荐的内置工作流

ワークフロー動作デフォルト状態推奨
Item closedIssue/PR がクローズされたら Status → Done有効そのまま維持
Pull request mergedPR がマージされたら Status → Done有効そのまま維持
Item reopenedIssue が再オープンされたら Status → Todo無効有効化を推奨
Item added to projectアイテム追加時に Status → Todo無効有効化を推奨
Auto-add to projectフィルタに一致する Issue/PR を自動追加無効有効化を推奨
Auto-archive itemsDone から N 日後に自動アーカイブ無効任意
Auto-close issueボードで Done にすると Issue を自動クローズ無効有効化を強く推奨
重要: Auto-close を有効にしないと、ボード上で Status を Done にしても Issue は自動クローズされない。双方向同期には必須。
工作流动作默认状态推荐
Item closed当Issue/PR被关闭时,将Status设为Done启用保持默认
Pull request merged当PR被合并时,将Status设为Done启用保持默认
Item reopened当Issue被重新打开时,将Status设为Todo禁用推荐启用
Item added to project添加项目项时,将Status设为Todo禁用推荐启用
Auto-add to project自动添加符合过滤条件的Issue/PR禁用推荐启用
Auto-archive itemsDone状态N天后自动归档禁用可选
Auto-close issue在看板上将状态设为Done时自动关闭Issue禁用强烈推荐启用
重要提示: 若不启用Auto-close,即使在看板上将Status设为Done,Issue也不会自动关闭。这是双向同步的必需设置。

Auto-add フィルタ例

Auto-add过滤示例

is:issue,pr is:open repo:<owner>/<repo>
ラベルで絞り込む場合:
is:issue,pr is:open label:sprint-1 repo:<owner>/<repo>
is:issue,pr is:open repo:<owner>/<repo>
按标签筛选时:
is:issue,pr is:open label:sprint-1 repo:<owner>/<repo>

Step 7: 継続的自動同期の案内

Step 7: 持续自动同步指引

ビルトインワークフローではカバーできない PR ライフサイクル連動(opened→In Progress, review_requested→In Review)などの高度な同期が必要な場合は、
project-sync-issues
スキルで GitHub Actions ワークフローを生成できることを案内する。
若需要内置工作流无法覆盖的高级同步(如PR生命周期联动:opened→In Progress, review_requested→In Review),可告知用户使用
project-sync-issues
技能生成GitHub Actions工作流。

Step 8: 作成結果を報告する

Step 8: 报告创建结果

以下の情報を表示:
  • プロジェクト URL
  • プロジェクト番号
  • 作成されたフィールド一覧
  • リンクされたリポジトリ
  • ビルトインワークフロー設定 URL
  • 推奨設定のチェックリスト
显示以下信息:
  • 项目URL
  • 项目编号
  • 创建的字段列表
  • 关联的仓库
  • 内置工作流设置URL
  • 推荐设置的检查清单

注意事項

注意事项

  • Status のオプション値はユーザーの要望に応じてカスタマイズ可能
  • フィールド作成でエラーが発生した場合(既に存在する等)はスキップして続行する
  • Organization プロジェクトの場合、適切な権限が必要
  • ビルトインワークフローは CLI/API では設定できないため、Web UI での設定が必要
  • sandbox 環境での
    GIT_SSL_NO_VERIFY=1
    併用
    :詳細は後述の「sandbox 環境での実行」節を参照
  • Status的选项值可根据用户需求自定义
  • 若字段创建时发生错误(如已存在等),则跳过并继续执行
  • 创建组织项目时需要具备相应权限
  • 内置工作流无法通过CLI/API配置,必须通过Web UI操作
  • sandbox环境下需配合
    GIT_SSL_NO_VERIFY=1
    :详情请参考后文的「sandbox环境下执行」章节

sandbox 環境での実行

sandbox环境下执行

sandbox で本スキルを実行する場合、ネットワーク越しの GitHub 操作には
GIT_SSL_NO_VERIFY=1
の併用を検討してください。本スキルの主なリモート操作は
gh project create
/
gh api
で、「リモート書き込み」判定は 要(本スキルは主に API 経由) です。コマンド分類の詳細と TLS 検証無効化の注意事項は
docs/sandbox-tls.md
を参照してください。
在sandbox环境中执行本技能时,对于跨网络的GitHub操作,建议配合使用
GIT_SSL_NO_VERIFY=1
。本技能的主要远程操作为
gh project create
/
gh api
,「远程写入」判定为需要(本技能主要通过API执行)。命令分类详情及TLS验证禁用的注意事项请参考
docs/sandbox-tls.md