Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[code-generator] 自動生成コードの @note に,生成元DBのコミットハッシュと生成パラメータを出力する #240

Merged
merged 21 commits into from
Dec 18, 2023

Conversation

meltingrabbit
Copy link
Member

@meltingrabbit meltingrabbit commented Dec 14, 2023

概要

自動生成コードの @note に,生成元DBのコミットハッシュと生成パラメータを出力する.
これによって,生成されたコードから,元のDBや生成パラメータがわかるようになる

自身のdbから生成されたコードには,そのdbに含まれるすべてのcsvのmd5を結合したものをさらにmd5にしたもの,
sub obcのdbについては,そのコミットハッシュを記録している.

Issue

NA

検証結果

CIが通ればOK

影響範囲

  • code generator をかけたかどうかを判断するCIにも修正が必要
  • 該当repositoryのtlm-cmd-dbについては,最新版のdbとコードが同期されていることが重要だが,MOBCに含まれるsub obcのdbについては,多くが外部repositoryであり,また常に最新版とは限らないので,CIではチェックを除外した

@meltingrabbit meltingrabbit added documentation Improvements or additions to documentation priority::medium priority medium tools labels Dec 14, 2023
@meltingrabbit meltingrabbit self-assigned this Dec 14, 2023
@meltingrabbit
Copy link
Member Author

meltingrabbit commented Dec 14, 2023

@ToshiAki64 @hender14
これまで,コード生成されたコードがどう生成されたのか不明だったので,generator を修正してみました.
レビューお願いできますか?

@meltingrabbit meltingrabbit changed the title WIP: Feature/add metadata for generator [code-generator] 自動生成コードの @note に,生成元DBのコミットハッシュと生成パラメータを出力する Dec 14, 2023
Comment on lines 12 to 14
* path_to_db: ../examples/subobc/tlm-cmd-db/
* max_tlm_num: 256
* driver_path: aocs/
Copy link
Collaborator

Choose a reason for hiding this comment

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

path_to_dbdriver_pathって、各自で別のpathになる可能性があり、各衛星ブランチで共通のドライバをdevelopからマージする際にドライバを生成した人の環境によって、変わってしまうのではないかと思ったのですが?

Copy link
Member Author

Choose a reason for hiding this comment

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

たしかにそうですね.
消す場合,sub obcの場合は,どのリポジトリか?の情報が残せないのがつらいですね.少し考えます

Copy link
Member Author

Choose a reason for hiding this comment

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

リポジトリ名と,
自身のDBの場合は,DBの全csvのダイジェスト,
sub obcについてはそのコミットハッシュを残すようにしました.

code-generator/my_mod/util.py Outdated Show resolved Hide resolved
code-generator/my_mod/util.py Outdated Show resolved Hide resolved
@meltingrabbit meltingrabbit force-pushed the feature/add_metadata_for_generator branch from 6ba4ef7 to 9105700 Compare December 15, 2023 11:39
CHANGELOG.md Outdated Show resolved Hide resolved
@meltingrabbit
Copy link
Member Author

@hender14 @ToshiAki64 レビューお願いします

@meltingrabbit meltingrabbit merged commit 105dc1d into main Dec 18, 2023
38 checks passed
@meltingrabbit meltingrabbit deleted the feature/add_metadata_for_generator branch December 18, 2023 04:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation priority::medium priority medium tools
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants