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.

Sign up for GitHub

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

Update CHANGELOG for v4.4.0 release #333

Merged
merged 7 commits into from
May 13, 2024
Merged

Update CHANGELOG for v4.4.0 release #333

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9dd8695
Update CHANGELOG.md
meltingrabbit Apr 11, 2024
7cb3d94
Update CHANGELOG.md
meltingrabbit Apr 11, 2024
1938bda
add migration guide
meltingrabbit Apr 11, 2024
59db585
typo
meltingrabbit Apr 11, 2024
3db8dcc
review
meltingrabbit Apr 11, 2024
ae525f6
write v4.4.0 changelog
sksat Apr 15, 2024
705e0f2
Update CHANGELOG.md
meltingrabbit May 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 72 additions & 4 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,80 @@
注意: これは既存の C2A core update の「リリースの間の Pull Request を眺めてなんとなく察する」という曖昧な操作を緩和していくための試みであり，C2A user に対するお知らせを行う場として使っていくことを意図しています．初めから c2a-core の全変更を取り扱うと不必要に煩雑になるだけになってしまうため，完全な変更内容の一覧についてはこれまで通り [GitHub Releases](https://github.com/arkedge/c2a-core/releases) などから参照してください．


## v4.4.0 (2024-xx-xx)
## v4.4.0 (2024-05-13)

### Breaking Changes

- code-generator
- [#312](https://github.com/arkedge/c2a-core/pull/312): コマンドの説明を cmd definition の doxygens コメントに出力
- [#313](https://github.com/arkedge/c2a-core/pull/313): コード生成時に不要な空白を除去
- [#306](https://github.com/arkedge/c2a-core/pull/306): MOBC を想定した機能を有効化するためのビルドオプションを追加
- [#310](https://github.com/arkedge/c2a-core/pull/310): Common Packet のディレクトリ変更
- [#329](https://github.com/arkedge/c2a-core/pull/329): Common Packet のデフォルト実装を core から提供する（Space Packet のみ）
- [#330](https://github.com/arkedge/c2a-core/pull/330): Rename c2a-sils-runtime to c2a-dev-runtime

### Enhancements

- [#327](https://github.com/arkedge/c2a-core/pull/327): Add rust-toolchain override config

### Fixed

- [#319](https://github.com/arkedge/c2a-core/pull/319): Block Command Executor の Rotator の実行開始コマンド位置の修正
- BCE Rotator において，Rotate する BC の 0 番目のコマンドから実行されることを本来意図していた．
- 実際は 1 番目のコマンドから実行されていたため，意図通りの挙動になるように修正された．


### Documentation
- [#328](https://github.com/arkedge/c2a-core/pull/328): C2A User 開発者のための簡易なドキュメントを追加
- [#331](https://github.com/arkedge/c2a-core/pull/331): Example user CMake config is not only for SILS-S2E


### Internal
- [#289](https://github.com/arkedge/c2a-core/pull/289): Update Rust crate bindgen to 0.69.4
- [#296](https://github.com/arkedge/c2a-core/pull/296): Update actions/cache action to v4
- [#288](https://github.com/arkedge/c2a-core/pull/288): Update actions/deploy-pages action to v4.0.4
- [#308](https://github.com/arkedge/c2a-core/pull/308): Update actions/upload-pages-artifact action to v3.0.1
- [#295](https://github.com/arkedge/c2a-core/pull/295): Update sksat/setup-rye action to v0.15.0
- [#293](https://github.com/arkedge/c2a-core/pull/293): Update sksat/action-clippy action to v0.7.1
- [#294](https://github.com/arkedge/c2a-core/pull/294): Update dependency ut-issl/s2e-core to v7.2.5
- [#290](https://github.com/arkedge/c2a-core/pull/290): Update Swatinem/rust-cache action to v2.7.3
- [#307](https://github.com/arkedge/c2a-core/pull/307): Update actions/setup-node action to v4.0.2
- [#316](https://github.com/arkedge/c2a-core/pull/316): Update actions/cache action to v4.0.1
- [#315](https://github.com/arkedge/c2a-core/pull/315): Update Rust crate kble-socket to 0.3.0
- [#311](https://github.com/arkedge/c2a-core/pull/311): Update Rust crate semver to 1.0.22
- [#322](https://github.com/arkedge/c2a-core/pull/322): Update actions/deploy-pages action to v4.0.5
- [#323](https://github.com/arkedge/c2a-core/pull/323): Update actions/cache action to v4.0.2
- [#325](https://github.com/arkedge/c2a-core/pull/325): Update actions/setup-python action to v5.1.0
- [#324](https://github.com/arkedge/c2a-core/pull/324): Update dependency ut-issl/s2e-core to v7.2.6
- [#314](https://github.com/arkedge/c2a-core/pull/314): Update sksat/setup-rye action to v0.20.0
- [#309](https://github.com/arkedge/c2a-core/pull/309): Update arkedge/workflows-c2a action to v5.2.0
- [#333](https://github.com/arkedge/c2a-core/pull/333): Update CHANGELOG for v4.4.0 release


### Migration Guide
- [#319](https://github.com/arkedge/c2a-core/pull/319): `rotator` で TI＝0 のコマンドから実行されるように修正
- デバッグ出力を使用している user は，起動時の表示タイミングが変わるため，この PR の Example user の変更を取り込むこと
- rotator で実行順に依存するような処理がある場合は，適宜 Task list の並び替えを行うこと
- コード生成
- [#312](https://github.com/arkedge/c2a-core/pull/312), [#313](https://github.com/arkedge/c2a-core/pull/313): code-generator の機能追加・生成コード仕様の変更があるため，コード生成し直すこと（MUST）
- [#319](https://github.com/arkedge/c2a-core/pull/319): BCE Rotator の挙動を意図通りに修正したので，各 User で影響範囲を確認し，必要に応じて修正すること（MUST）
- BCE Rotator で実行順に依存するような処理がある場合は，適宜 TaskList 等の並び替えを行うこと
- Example User のデバッグ出力 App は，本 PR 適用前の BCE Rotator の誤った挙動に依存した BC 登録となっていた
- 同様なデバッグ出力 App を使用している user は，起動時の表示タイミングが変わるため，この PR の Example user の変更を取り込むこと
- [#306](https://github.com/arkedge/c2a-core/pull/306), [#329](https://github.com/arkedge/c2a-core/pull/329): MOBC を意図した User では，c2a-core をビルドする際 `C2A_MOBC_FEATURES` を define すること（MUST）
- ビルドシステムに CMake を用いている場合は，同名の CMake option の `C2A_MOBC_FEATURES` を `ON` にする
- [#310](https://github.com/arkedge/c2a-core/pull/310), [#329](https://github.com/arkedge/c2a-core/pull/329): Common Packet として Space Packet を利用している User では，c2a-core が提供するデフォルト実装を利用する（RECOMMENDED）
- デフォルト実装が [src/src_core/tlm_cmd/common_packet/space_packet](./tlm_cmd/common_packet/space_packet) にあるので，ビルド対象に加える
- ビルドシステムに CMake を用いている場合は，[C2A_USE_SPACE_PACKET_AS_COMMON_PACKET](https://github.com/arkedge/c2a-core/blob/80e6c96acbbd8551c174a586710a1d573de8206c/CMakeLists.txt#L22) を `ON` にする
- User に含まれる以下のファイルが不要になるため，削除する
- `src/src_user/tlm_cmd/common_cmd_packet.c`
- `src/src_user/tlm_cmd/common_tlm_cmd_packet.c`
- `src/src_user/tlm_cmd/common_tlm_packet.c`
- `src/src_user/settings/tlm_cmd/common_tlm_packet_define.c` を新規に作成し， `CTP_set_global_time()` を定義する
- 実装例: [examples/subobc/src/src_user/settings/tlm_cmd/common_tlm_packet_define.c](https://github.com/arkedge/c2a-core/blob/80e6c96acbbd8551c174a586710a1d573de8206c/examples/subobc/src/src_user/settings/tlm_cmd/common_tlm_packet_define.c)
- コンパイルが通るように，以下の include の修正を行う
- `#include <src_core/tlm_cmd/common_cmd_packet.h>` -> `#include <src_core/tlm_cmd/common_packet/common_cmd_packet.h>`
- `#include <src_core/tlm_cmd/common_cmd_packet_util.h>` -> `#include <src_core/tlm_cmd/common_packet/common_cmd_packet_util.h>`
- `#include <src_core/tlm_cmd/common_tlm_cmd_packet.h>` -> `#include <src_core/tlm_cmd/common_packet/common_tlm_cmd_packet.h>`
- `#include <src_core/tlm_cmd/common_tlm_cmd_packet.h>` -> `#include <src_core/tlm_cmd/common_packet/common_tlm_cmd_packet.h>`
- [#330](https://github.com/arkedge/c2a-core/pull/330): `c2a-sils-runtime`を用いていた C2A user の `Cargo.toml` や `src/main.rs` などで crate 名を `c2a-dev-runtime` に変更する


## v4.3.0 (2024-02-06)
Expand Down
Loading