本文へ移動
Wagby11
マニュアルのグループを選ぶ

WAGBY11 MANUAL / 01

AppSchemaの版と改版履歴を管理する

設計の区切りにAppSchemaの版と改版履歴を残すタイミング、AIへの指示方法、AWS転送前の記録と確認を説明します。

最終更新日:

はじめにの小目次へ

1. このページで伝える機能

AppSchemaの改版履歴に、いつ、誰が、何を変更したかを版単位で残せます。開発者が任意のタイミングでAIへ記録を依頼でき、AWSへ転送する前にも、その設計の変更内容をまとめておけます。

機能追加や不具合修正の区切りに記録することで、テスト対象の確認、担当者への引継ぎ、変更理由の振り返りに役立ちます。AIへ、記録する変更とその区切りを伝えます。

2. Wagby11で実現できること

2.1 版と変更内容を記録する

ルートのAppSchemaのアプリケーション説明(description)に、現在の版、更新日時、改版履歴(history)を保持します。版はAppSchemaの設計情報を識別するものです。Wagbyの製品の版や、AWSへ配置するときのリリース名とは区別して管理します。

記録する内容使い方
対象版どの設計に対する変更かを識別します。履歴内で同じ版を重複させません。
改版日その版をまとめた日を記録します。
更新担当者担当者や担当部署を記録します。担当者が未指定の場合、AIに実在の担当者名を推測して記入させず、確認して決めます。
変更概要追加・変更・修正の内容と、必要に応じて変更理由やデータ移行上の注意を短くまとめます。

対象版と改版日は必須です。更新担当者と変更概要は任意項目ですが、開発の経緯を共有できるように記録することをおすすめします。

2.2 記録するタイミングを決める

基本は「設計の区切りができたとき」と「その設計を他の担当者や環境へ渡すとき」です。次のタイミングを目安に、開発の進め方に合わせてAIへ追記を依頼します。

タイミング記録する内容の例
初版の設計がまとまったとき対象業務と、最初に用意したモデル・主な機能。
機能追加・仕様変更が一段落したときモデルや項目の追加、入力チェック、承認経路の変更。
不具合を修正し、動作確認を終えたとき問題が起きた条件と修正内容。確認済みの範囲。
利用者レビューの指摘を反映したとき業務上の要望と、それに応じて変更した内容・理由。
データ移行や互換性に影響する変更を確定したとき項目の削除・型変更・必須化などの変更と、適用時の注意。
権限や公開範囲を変更したとき対象の利用者・ロールと、許可する操作や公開範囲の変更。
テスト・受入確認に渡すとき確認対象となる版と、その版までに確定した変更。
AWSへ転送するとき転送する設計の変更概要。転送前に履歴を確定します。
担当者の交代や開発の中断時その時点までに確定した変更。未対応事項は変更済みの内容と区別します。
以前の設計へ戻すことを確定したとき戻した対象と理由。過去の履歴を保持し、新しい版の履歴として残します。

2.3 変更を版単位にまとめる

AIへの指示やファイルの保存のたびに版を増やす必要はありません。「顧客検索の改善」など、説明できるひとまとまりの変更を1つの版にまとめます。既存の採番方針に従い、現在の版と今回追加する履歴の対象版を合わせます。履歴は古い版から新しい版の順に並べます。

変更概要は実際に反映した内容を記録します。未実装の予定や未実施のテストを完了事項として書かないようにします。改版しても初回作成日は保持し、更新日時を実際の更新に合わせます。

2.4 AWSへ転送する前に記録する

AWSへ転送する作業をAIに依頼するとき、改版履歴の更新も含めて指示できます。配置ツールによる自動追記を前提にせず、AIへの依頼に記録の作業を明記します。

  1. 前回の改版以降の変更を確認し、転送する設計の版と履歴を確定します。
  2. 設計情報を検証し、履歴を反映したアプリを生成・ビルドします。
  3. 生成した成果物をAWSへ転送し、実行IDで配置の完了を確認します。
  4. 配置後の画面で対象の版と履歴を確認し、必要な業務操作を試します。

AppSchemaに変更がない同じ版の再転送では、同じ版の履歴を重複追加しません。配置の成功・失敗や実行IDは配置の実行記録で確認します。転送前の履歴に「配置成功」「業務確認済み」と先に記録しないようにします。

具体的な配置手順は、H2のテスト環境を構築するとRDS MySQLの本番環境を構築するを参照してください。

2.5 アプリケーションの画面で確認する

管理者は、ログオン後に「システム → システム運用 → このアプリケーションについて」を開き、版と「変更履歴」を確認できます。画面例はアプリケーションの名前と説明を整えるに掲載しています。

画面に表示するのは、起動したアプリに含まれる設計情報です。AppSchemaを編集しただけでは起動済みの画面へ反映されないため、生成・ビルド・再起動または再配置を行ってから確認します。反映されない場合は定義の反映状況も確認します。

3. AIへの指示例

最小限の指示例

今回の変更を一区切りとして、AppSchemaの改版履歴に追記してください。

AIは既存の履歴や今回の作業内容から、記録対象の変更、変更概要、採番方法などを類推して補います。変更理由が会話や資料にない場合や担当者が決まっていない場合は、必要な情報を確認します。既存履歴がなく変更範囲を特定できない場合は、記録対象を具体的に伝えます。この短い指示だけで、次の詳細例と同じ内容になるとは限りません。

より詳細な指示例

機能変更や不具合修正の完了時に記録する

前回の改版以降に確定した、顧客検索の改善と電話番号の入力チェック修正を、AppSchemaのhistoryに追記してください。
・既存の採番方針に従って新しい版を決め、description.versionと今回の履歴の対象版を合わせてください。
・改版日と更新日時は実際の更新に合わせ、担当は「営業企画部」としてください。初回作成日は保持してください。
・変更概要には、変更内容と理由、確認済みの範囲を簡潔にまとめてください。
・未実装の予定や未実施のテストを完了事項に含めないでください。
・既存履歴を保持し、古い版から新しい版の順に並べ、対象版が重複しないことを検証してください。
追記した内容と検証結果を説明してください。

AWSへの転送前に記録する

今回確定した変更をAWSのテスト環境へ転送してください。転送前にAppSchemaの改版履歴も更新してください。
・前回の改版以降の変更を確認し、今回の対象版、改版日、担当、変更概要を記録してください。担当は「営業企画部」とします。
・既存の採番方針と履歴を保持し、description.versionとupdated_atも整えてください。
・同じ版の再転送で設計に変更がなければ、履歴を重複追加しないでください。
・履歴の更新後に検証・生成・ビルドし、その成果物を転送してください。
・配置の成功や業務確認の完了を、転送前の履歴に記録しないでください。
・配置後は実行IDで完了を確認し、画面の版と変更履歴、実施した業務確認の結果を報告してください。

4. 編集されるAppSchemaの例

ルートのdesigner/repository/appschema.yamlにあるdescriptionの抜粋です。初版の履歴を保持したまま、顧客検索を改善した版を追記した例です。ここに示す版番号は業務アプリケーションの設計情報の例で、Wagbyの製品の版ではありません。

description:
  system_name: 顧客・商品管理
  overview: 顧客の連絡先と商品情報を管理するアプリケーション。
  version: '1.1.0'
  created_at: '2026-10-31'
  updated_at: '2026-11-04T10:00:00+09:00'
  owner: 営業企画部
  history:
    - version: '1.0.0'
      date: '2026-10-31'
      author: 営業企画部
      comment: 顧客・商品管理の初版を作成
    - version: '1.1.0'
      date: '2026-11-04'
      author: 営業企画部
      comment: 問い合わせ対応のため顧客検索の一覧に担当者名と電話番号を追加

現在の版はdescription.version、各改版の対象版はhistory内のversionです。この例では両方を今回の版に合わせています。未掲載の既存設定は保持します。

referenceではSemantic Versioning(MAJOR.MINOR.PATCH)を推奨しています。対象版は履歴内で一意にし、日付はISO-8601の日付形式、更新日時はISO-8601の日時形式で記録します。

5. 参考資料

reference:description(アプリケーション説明)
designer/docs/appschema/markdown/reference/03-description.md
Web UI:このアプリケーションについて
web-ui/docs/html/20_about_application.html