Skip to content

docs: [name] / --context を取るサブコマンドの列挙を揃え、profiles に requires.devbase の手順を足す (#208, #195) - #213

Merged
takemi-ohama merged 2 commits into
release/v3.7.0from
feature/v3.7.0-docs-enumeration
Sep 22, 2026
Merged

takemi-ohama merged 2 commits into
release/v3.7.0from
feature/v3.7.0-docs-enumeration

Conversation

@takemi-ohama

@takemi-ohama takemi-ohama commented Sep 21, 2026 •

Copy link
Copy Markdown
Contributor

Summary

文書だけの変更です。本番の振る舞いも本番コードの構造も変えません(モード: light)。

このまとまりの release Pull Request は #212 です(base は release/v3.7.0)。

正本とした集合

lib/devbase/cli.py の _create_parser() を走査して得た集合を正としています。

集合 実際の値
project <sub> [name] up / down / ps / logs / scale / rebuild / open(bin/devbase の _PROJECT_NAME_SUBCOMMANDS と一致)
[name] を取るが解決の経路が違う project profile up / profile down / profile list(wrapper では位置で解決できず、_dispatch_lifecycle が解決する)
--context project / container / ct 配下の up / down / ps / logs / login / scale / build / rebuild / open / profile up / profile down / profile list、トップレベルの up / down / ps / login / scale / rebuild / open、および env exec / env token

受け入れ条件

#208

  • 1. docs/user/cli-reference/02-project.md の [name] の列挙に rebuild と open が含まれる
  • 2. docs/user/cli-reference/README.md の mermaid D1 の列挙に open が含まれる
  • 3. docs/user/cli-reference/README.md のショートカットの表に devbase open [name] の行があり、profile にも触れている(現状は open にも profile にも一度も触れていない)
  • 4. docs/user/container-operations.md の [name] の列挙に rebuild と open が含まれる
  • 5. docs/specifications/compose-profiles.md の up down ps logs scale rebuild の列挙に open が含まれる
  • 6. [name] を直した文書に「profile も [name] を取るが、解決の経路が違う」旨の 1 行がある
  • 7. docs/user/cli-reference/02-project.md の --context の列挙に open が含まれる
  • 8. docs/specifications/remote-docker-context.md の 2 か所の --context の列挙に open が、後者にはさらに env token が含まれる
  • 9. docs/user/environment-variables.md の --context の列挙に open が含まれる
  • 10. argparse を走査して得た集合と、上の各文書の列挙が一致する(差分ゼロ)
  • 11. 直す対象ではないと issue が名指しした 2 か所(docs/specifications/cli-argument-resolution.md の「他のショートカット」、docs/user/environment-variables.md の DEVBASE_DOCKER_CONTEXT の行)を書き換えていない

#195

  • 12. docs/plugin-dev/compose-profiles.md の「使える環境」の表の devbase の行が 3.5.0 以上 と具体的な版数で書かれている
  • 13. docs/plugin-dev/compose-profiles.md の「1. compose.yml の書き方」の末尾に、requires.devbase を ">=3.5.0" へ上げる手順がある
  • 14. docs/plugin-dev/plugin-yml-reference.md の「上げる契機」が project.yml 形式への移行だけに限定されておらず、profiles: の導入も契機として挙がっている
  • 15. 上の 2 ファイルが相互にリンクしており、版数の記述が食い違わない

共通

  • 16. 変更が docs/ 配下だけに閉じている(lib/ / bin/ / etc/ / tests/ を触らない)

やらないこと(範囲外)

どちらの issue も本文で「恒久策は範囲を超える」と明示しています。次の 2 件はこの Pull Request に入れず、別の issue として起票します。

コードと補完(etc/devbase-completion.bash / etc/_devbase)に漏れは無いため、この Pull Request では触りません。

Test plan

実行済みです。

# 確かめたこと やり方 結果
1 argparse の集合と文書の列挙が一致する lib/devbase/cli.py の _create_parser() を再帰で走査し、name positional / --context を持つ parser を集めて、上の 8 か所の列挙と突き合わせる検査スクリプト exit=0(11 項目すべて ok、FAILS: なし)
2 #195 の受け入れ条件(版数・手順・相互リンク) 検査スクリプトで 7 項目を判定 exit=0(FAILS: なし)
3 変更した 8 ファイルの相対リンクとアンカーが解決する 見出しから GitHub 互換のアンカーを生成し、本文中の ](...) を突き合わせる exit=0(切れたリンク 0 件)
4 変更が docs/ 配下だけ git diff --name-only | grep -v '^docs/' 出力なし(8 ファイルすべて docs/、+59 -15)
5 非対象の 2 か所を触っていない docs/specifications/cli-argument-resolution.md は差分なし。docs/user/environment-variables.md の DEVBASE_DOCKER_CONTEXT の行は差分 0 行 ok

検査で確かめた argparse 側の集合:

project [name]        : down logs open ps rebuild scale up
project --context     : build down login logs open ps rebuild scale up
                        profile up / profile down / profile list
top-level --context   : down login open ps rebuild scale up
env --context         : env exec / env token

lib/ / bin/ / etc/ / tests/ を触らないため、pytest と devbase --help の結果はこの Pull Request で変わりません。

検査(実装レビュー / 完了判定)

実装レビュー — /ndf:cross-review 213

round レビュワー 判定 指摘
1 agy / kiro APPROVE / APPROVE 0 件 / 0 件
2 codex / kiro APPROVE / APPROVE 0 件 / 0 件

ホスト(claude)を除く 3 ランタイムすべてがこの差分を見て承認しました。round 1 で
収束しましたが、輪番から外れた codex がこの差分を見ていないため round 2 を回しています。
未解決のレビュースレッドは GitHub 側で数え直して 0 件(state.py verify-sweep → exit=0)。

完了判定 — /ndf:quality-gates(モード light)

段階 コマンド 対象範囲 実行時刻 結果
変更箇所を通る経路 python3 -m devbase.cli project --help / project open --help / project profile up --help 文書が列挙するサブコマンド 2026-09-22 06:11 exit=0。open に [name] と --context、profile up に [name] と --context があることを確認
事実確認 argparse(_create_parser() の再帰走査)と bin/devbase の _PROJECT_NAME_SUBCOMMANDS を、変更した 8 ファイルの列挙と突き合わせる検査スクリプト 列挙 8 項目 2026-09-22 06:10 exit=0(0 failure(s))
リンク・アンカー検査 変更した 8 ファイルの内部リンク 54 件を、見出しから作った GitHub 互換アンカーと突き合わせる 変更ファイル 8 件 2026-09-22 06:09 exit=0(0 problem(s))
静的解析 python3 -m compileall -q lib bin lib / bin 2026-09-22 06:10 exit=0
静的解析 uvx ruff check --select=E9,F63,F7,F82 lib lib 2026-09-22 06:10 exit=0(All checks passed!)
静的解析 uvx --from shellcheck-py shellcheck bin/devbase bin/devbase 2026-09-22 06:14 exit=1(既存の失敗。下記)

突き合わせた argparse / bin/devbase 側の集合:

_PROJECT_NAME_SUBCOMMANDS : down logs open ps rebuild scale up
project 配下の [name]      : down logs open ps rebuild scale up
                             profile down / profile list / profile up
トップレベルの [name]      : down open ps rebuild scale up
project 配下の --context   : build down login logs open ps rebuild scale up
                             profile down / profile list / profile up
env 配下の --context       : exec token
トップレベルの --context   : down login open ps rebuild scale up
                             (build は bin/devbase の cmd_build が _BUILD_CONTEXT で受けて転送)
logs にトップレベルのショートカットは無い
  • 未検証の項目: 全体テスト(pytest)と結合テスト。モード light の必須段階に含まれず、
    この Pull Request は docs/ の 8 ファイルだけで非 docs の差分が 0 件のため。
  • 既存の失敗: shellcheck bin/devbase が exit=1(8 件)。release/v3.7.0 時点の
    bin/devbase でも同じ 8 件が出るため、この Pull Request が原因ではありません
    (git diff --name-only release/v3.7.0...HEAD -- . ':!docs' の出力は 0 件)。
  • 範囲外と判断したもの: リリースブランチ宛の Pull Request で CI の検査ジョブが 1 件も
    動かない(.github/workflows/ci.yml の on.pull_request.branches が main だけ)。
    この Pull Request でも gh pr checks 213 は no checks reported を返します。
    → ci: リリースブランチ宛の Pull Request で検査ジョブが 1 件も動かない(on.pull_request.branches が main だけ) #216 として起票

Closes #208
Closes #195

🤖 Generated with Claude Code

takemi-ohama and others added 2 commits September 22, 2026 05:43
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
…の手順を足す

#208: argparse の集合を正本として、文書 8 か所の列挙に rebuild / open を足す。
  - [name]: 02-project.md / cli-reference/README.md(mermaid・ショートカットの表)/
    container-operations.md / specifications/compose-profiles.md
  - --context: 02-project.md / remote-docker-context.md の 2 か所(env token も)/
    environment-variables.md
  - profile も [name] を取るが解決の経路が違うことを 1 行添える
  - cli-argument-resolution.md と DEVBASE_DOCKER_CONTEXT の行は正しいので触らない

#195: profiles: を使う Plugin が plugin.yml の requires.devbase を ">=3.5.0" へ
  上げる手順を plugin-dev/compose-profiles.md へ足し、上げる契機を 1 つに限定していた
  plugin-yml-reference.md 側を広げて相互リンクする。

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

@takemi-ohama takemi-ohama left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 cross-review | round 1 | kiro | APPROVE

lib/devbase/cli.py(_create_parser 系の _add_name_arg / _add_context_arg)と bin/devbase の _PROJECT_NAME_SUBCOMMANDS(up down ps logs scale rebuild open)を正本として、変更 8 ファイルの [name] / --context 列挙・profile の扱い・>=3.5.0(CHANGELOG [3.5.0] と一致)・追加した相互リンクのアンカー(#requires / #plugin-として配るなら-requiresdevbase-を-350-以上へ上げる)まで突き合わせ、いずれも一致・解決を確認した。範囲外とされた cli-argument-resolution.md にも新たな不整合は無い。修正提案は無し。

@takemi-ohama takemi-ohama left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 cross-review | round 1 | agy | APPROVE

argparse の定義および bin/devbase の実装と各ドキュメントの列挙が整合しており、追加されたリンク・アンカーやバージョン要件(>=3.5.0)の手順にも問題は見当たりません。

@takemi-ohama takemi-ohama left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 cross-review | round 2 | codex | APPROVE

修正が必要な指摘はありません。

@takemi-ohama takemi-ohama left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 cross-review | round 2 | kiro | APPROVE

lib/devbase/cli.py の _add_project_parser / _add_shortcuts / _add_profile_subparser / _add_open_subparser と bin/devbase の _PROJECT_NAME_SUBCOMMANDS(up down ps logs scale rebuild open)を実際に走査し、変更した 8 文書の [name] 列挙・--context 列挙・profile の解決経路の記述が正本と一致することを確認しました。compose-profiles.md ↔ plugin-yml-reference.md の相互リンクのアンカー、README.md → 02-project.md#プロジェクト名指定cwd-非依存 も解決します。CHANGELOG [3.5.0] が devbase project profile の初出であることも一致しています。非対象と宣言された cli-argument-resolution.md は差分なしです。修正を要する不整合は見つかりませんでした。

@takemi-ohama

Copy link
Copy Markdown
Contributor Author

範囲外と判断し、#216 として残した(リリースブランチ宛の Pull Request で CI の検査ジョブが 1 件も動かない)。この PR の差分は docs/ の 8 ファイルのみで、.github/ を触らない。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant