運用上の注意事項

Next Design および NDMerge を用いたGitでの開発フローにおいて、下記の点にご注意いただくことで運用しやすくなります。

コンフリクトを極力少なくする

• NDMerge によるマージは、ファイル単位(.nmdlファイルなどの単位）で行います。そのため、下記の点に注意しておくことでコンフリクトが起きにくくなります。
  • 細かくモデルファイル分割しておくことで、コンフリクトしにくくなります。
    • 特に並行して開発する可能性のあるモデル同士はモデルファイル分割しておくことをお勧めします。
  • メタモデルの構造も並行開発を前提とした構造で定義しておくと、より運用がスムーズとなります。
    • 例えば共通のデータ定義を参照用に1つ用意しデータ定義を参照できるようにした上で、コンポーネント毎に分割・設計できるような構造などが挙げられます。
  • さらに下記にご注意いただくことで、余分なコンフリクトを避け運用することができます。
    • プロジェクト自体の編集は並行して行わない。
      • 特にモデルファイルの分割、統合、参照登録はブランチ個別では行わない。
    • プロファイルの編集は並行して行わない。
    • プロダクトラインのモデル(特にフィーチャモデル、コンフィグレーション)の編集は並行して行わない。

モデルの不整合を防ぐ

• 次のケースでは、マージ結果として不整合なモデルとなる可能性があります。これらが並行編集とならないように注意してください。
  • ファイルを跨ぐような編集とそれに関係するモデルの並行編集
    • モデルファイルの分割や統合とそのモデルファイル内のモデルの編集
    • モデルファイルをまたがるモデルの移動とそのモデルのフィールドの編集
  • プロファイルの編集とそれに関係するモデルの並行編集
  • モデルの型変更とそのモデルのフィールドの並行編集
  • 同じモデルの子要素モデルや参照モデルの順序の並行編集

テキストでの差分を確認しやすくする

• プロジェクトをJSON形式で保存することで、モデルの変更差分がテキストでも確認できるようになります。下記の点に注意しておくことでGit上でのテキスト差分を確認しやすくなります。
  • DB形式のプロジェクトを、JSON形式のプロジェクトで保存しなおします。
    • DB形式のファイルも名前を付けて保存により、JSON形式で保存しなおすことができます。
    • デフォルトの保存形式は、リボンのバックステージのオプションタブにある保存形式から変更できます。
• 参照先のモデルパスも含める設定にしておくと、参照元・先の関係性がわかりやすくなります。
  • NDMergeではファイル単位でマージされるため、参照先のパスで示すモデルが別ファイルの場合、必ずしも正しいパスを示すとは限りません。
    • 別ファイルで、参照先モデルの名前が変わったり、モデルの移動があった場合に異なるパスとなる可能性があります。
  • 下記にて設定変更、および参照先のパスを最新に更新できます。
    • リボンのバックステージの情報タブにある保存オプションから参照先のモデルパスを含めるで設定を変更できます。
    • 同じく情報タブにあるプロジェクトファイルの管理からプロジェクトファイルの更新を実行することで参照先のパスを最新に更新できます。
• 親子関係にある要素は構造化しておくと、追加・削除・順序変更が確認しやすくなります。
  • フィールドインスペクタのフィールド項目にある構造化して保存するで設定を変更できます。

関連項目

• Gitを用いた開発フロー概要