Skip to content

docs(plugin-dev): compose-profiles の書き方に plugin.yml の requires.devbase を 3.5.0 以上へ上げる手順を足す #195

Description

@takemi-ohama

何を足すか

docs/plugin-dev/compose-profiles.md に、プラグイン側でやることとして次を足す。

  • profiles: を使うプロジェクトを含むプラグインは、plugin.ymlrequires.devbase">=3.5.0" へ上げる

触る場所は 2 ファイルある。

場所 現在の記述 直す内容
docs/plugin-dev/compose-profiles.md:10 「使える環境」の表の devbase の行が devbase project profile があるバージョン 3.5.0 以上devbase project profile が入った版)へ具体化する
docs/plugin-dev/compose-profiles.md の「1. compose.yml の書き方」の末尾 記述なし requires.devbase を上げる手順を足す
docs/plugin-dev/plugin-yml-reference.md:172 requires.devbase を上げるのは、Plugin が project.yml 形式へ移行したタイミングです」 契機を 2 つへ広げ、compose-profiles.md へ相互リンクする

plugin-yml-reference.md:172 は上げる契機を 1 つに限定しているため、compose-profiles.md だけを直すと 2 つの文書が食い違う。

なぜ

profiles: を付けると、3.5.0 未満の devbase では devbase up でテスト用サーバ群が起動しなくなり、起動の手段(profile up)も無い。requires.devbase を上げておけば新規の devbase plugin install は拒否され(lib/devbase/plugin/installer.pycheck_devbase_requirementPluginError を投げる)、update でも警告が出る(lib/devbase/plugin/updater.py:188warn_unmet_devbase_requirement)。仕組みそのものは既にあり、足すのは文書だけでよい。

">=3.5.0" が正しい版数であることは、devbase project profile が 3.5.0 で入ったことによる(CHANGELOG の [3.5.0] - 2026-09-17lib/devbase/cli.py_add_profile_subparser)。

volareinc/devbase-ext#31(PR #33)で carmo-system-console に profile を導入したとき、この手順は設計の段階で出ず、配布の直前に気づいて requires.devbase を上げた。書き方の文書にあれば設計の互換性の表で拾える。

修正レイヤー

現象レイヤー: docs/plugin-dev/compose-profiles.mddocs/plugin-dev/plugin-yml-reference.md

修正レイヤー: 同じ 2 ファイル。プラグインの書き方を決めているのはこの 2 つで、責務はここにある。

さかのぼると、devbase に新しい機能を足したとき、それを使うプラグインが上げるべき requires.devbase の下限を書く場所が決まっていないというプロセスの欠落がある。今回の profiles: は 3.5.0、project.yml 形式は別の版で、記録は機能ごとの文書に散っている。

採る手: 統合(consolidate_duplication)。恒久的に潰すなら plugin-yml-reference.md に「devbase の機能 ↔ 必要な最低版数」の一覧表を置き、新機能の PR でそこへ 1 行足す運用にする。

決めること

  • 恒久策(機能 ↔ 最低版数の一覧表と、新機能の PR でそこへ 1 行足す運用)をこの issue で作るか、別に分けるか。この issue の範囲は文書 2 ファイルの追記で、運用の導入はそれを超える

見つけた場所: volareinc/devbase-ext#31 の振り返り

進行

モード: light / 作業ツリー: .worktrees/feature/v3.7.0-docs-enumeration

  • 要求と受け入れ条件 — 2026-09-22 05:41
  • 作業場所の用意 — 2026-09-22 05:42
  • 設計
  • 素材の収集と出典の確定
  • ドキュメント再構成
  • ドキュメントレビュー
  • 計画
  • 実装 — 2026-09-22 05:47
  • 構造改善
  • 実装レビュー — 2026-09-22 05:51
  • 完了判定 — 2026-09-22 06:08
  • Pull Request — 2026-09-22 05:44
  • 確定仕様化
  • 後片付け
  • 配布
  • 体裁レビュー
  • リリース後テスト
  • 振り返り

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions