Skip to content

Commit

Permalink
Merge pull request #85 from arkedge/feature/add-changelog
Browse files Browse the repository at this point in the history
Create CHANGELOG.md & write v4 current change log
  • Loading branch information
sksat authored Sep 7, 2023
2 parents 89e56bc + 0070bf4 commit fc5702a
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 0 deletions.
71 changes: 71 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# CHANGELOG

注意: これは既存の C2A core update の「リリースの間の Pull Request を眺めてなんとなく察する」という曖昧な操作を緩和していくための試みであり,C2A user に対するお知らせを行う場として使っていくことを意図しています.初めから c2a-core の全変更を取り扱うと不必要に煩雑になるだけになってしまうため,完全な変更内容の一覧についてはこれまで通り [GitHub Releases](https://github.com/arkedge/c2a-core/releases) などから参照してください.

## v4.0.0 (Unreleased)

### Breaking Changes

- [ut-issl/c2a-core](https://github.com/ut-issl/c2a-core) [v3.10.0](https://github.com/ut-issl/c2a-core/releases/tag/v3.10.0) から ArkEdge Space Inc. による先行開発のために fork し,リポジトリを [arkedge/c2a-core](https://github.com/arkedge/c2a-core) に移行
- ライセンス情報の更新: [#1](https://github.com/arkedge/c2a-core/pull/1)
- 各ディレクトリ名・構造の変更
- example user を `minimum_user` -> `mobc`, `2nd_obc_user` -> `subobc` に変更: [#15](https://github.com/arkedge/c2a-core/pull/15)
- ディレクトリ名のコーディング規約を `CamelCase` から `snake_case` に変更: [#20](https://github.com/arkedge/c2a-core/pull/20)
- v4 系統ではこの変更は移行期間とし,あらゆるディレクトリ名を一気に変更する必要はないものとしている
- Rust の crate のためのディレクトリは小文字の `-` 区切りとする: [#42](https://github.com/arkedge/c2a-core/pull/42)
- C2A 用語の rename: [#8](https://github.com/arkedge/c2a-core/issues/8)
- `IfWrapper` -> `HAL` (Hardware Abstraction Layer): [#21](https://github.com/arkedge/c2a-core/pull/21), [#24](https://github.com/arkedge/c2a-core/pull/24)
- 歪なディレクトリ構造の修正: [#28](https://github.com/arkedge/c2a-core/issues/28)
- 移行には [scripts/migration/](./scripts/migration/) 以下の `v4-rename-*.sh` の migration script を使用可能
- example user についてはこの migration script のみで移行しているが,あらゆる C2A user の状況について考慮できているわけではないため,適宜対応が必要
- `hal`(旧 `IfWrapper`)のうち,古すぎるインターフェースを排除: [#23](https://github.com/arkedge/c2a-core/issues/23), [#25](https://github.com/arkedge/c2a-core/pull/25)
- 既に使われてしまっているものについては,各 C2A user で一旦雑に古いヘッダファイルを各々で持って対応可能(今後再設計する予定)


### Enhancements

- `c2a-core` crate で Rust 向けの binding を提供する :[#35](https://github.com/arkedge/c2a-core/pull/35), [#37](https://github.com/arkedge/c2a-core/pull/37)
- C2A 内で共通の [bindgen](https://github.com/rust-lang/rust-bindgen) の設定を使用可能にするため,[c2a-bind-utils](https://crates.io/crates/c2a-bind-utils) crate を追加
- C2A 単体での SILS のための C2A のランタイム実装である `c2a-sils-runtime` crate を追加
- 共通して使用可能な C2A HAL(旧 `IfWrapper`)実装群を追加
- C2A HAL 実装のテンプレートや,モックとして使用可能な noop 実装を追加: [#40](https://github.com/arkedge/c2a-core/pull/40)
- [kble](https://github.com/arkedge/kble) を使った SILS 向け UART 実装を追加: [#41](https://github.com/arkedge/c2a-core/pull/41)
- `c2a-sils-runtime` と Rust 製の C2A HAL 実装を使って,example user の C2A 単体での SILS(S2E なし)を実装: [#44](https://github.com/arkedge/c2a-core/pull/44), [#45](https://github.com/arkedge/c2a-core/pull/45)
- 新たな C2A 標準環境である `C2A Boom` を example user に導入: [#56](https://github.com/arkedge/c2a-core/pull/56)
- これに伴い,各種 ArkEdge 独自のライブラリ・ツール群が 導入・OSS 化された
- [Gaia](https://github.com/arkedge/gaia)
- [tlmcmddb-cli](https://github.com/arkedge/c2a-tlmcmddb)
- [kble](https://github.com/arkedge/kble)
- [C2A DevTools](https://github.com/arkedge/c2a-devtools)
- example user に対して,Gaia を用いた pytest を導入: [#59](https://github.com/arkedge/c2a-core/pull/59)
- [python-wings-interface](https://github.com/ut-issl/python-wings-interface) 互換の Gaia(`tmtc-c2a`)向けインターフェースとして [c2a-pytest-gaia](https://github.com/arkedge/c2a-pytest-gaia) を導入
- これに伴い,Python の仮想環境・ツールチェーン管理に [rye](https://rye-up.com/)

### Fixed

- `c2a-core` crate のためのソースファイルを `src/lib.rs` から `c2a_core.rs` に移動し,紛らわしい `src` ディレクトリを削除: [#30](https://github.com/arkedge/c2a-core/pull/30)

### Compatible C2A Tools

- [ut-issl/tlm-cmd-db v2.4.0](https://github.com/ut-issl/tlm-cmd-db/releases/tag/v2.4.0)
- [ut-issl/python-wings-interface v1.5.1](https://github.com/ut-issl/python-wings-interface/releases/tag/v1.5.1)
- [ut-issl/c2a-tlm-cmd-code-generator ae-v4 branch](https://github.com/ut-issl/c2a-tlm-cmd-code-generator/tree/ae-v4)
- [ut-issl/c2a-enum-loader ae-v4 branch](https://github.com/ut-issl/c2a-enum-loader/tree/ae-v4)
- [arkedge/gaia v0.5.0](https://github.com/arkedge/gaia/releases/tag/v0.5.0)
- [tlmcmddb-cli 0.2.0](https://crates.io/crates/tlmcmddb-cli/0.2.0)
- [kble 0.2.0](https://crates.io/crates/kble/0.2.0)
- [C2A DevTools](https://github.com/arkedge/c2a-devtools)


## Previous Releases

- [v3.10.0](https://github.com/ut-issl/c2a-core/releases/tag/v3.10.0)
- [v3.9.2](https://github.com/ut-issl/c2a-core/releases/tag/v3.9.2)
- [v3.9.1](https://github.com/ut-issl/c2a-core/releases/tag/v3.9.1)
- [v3.9.0](https://github.com/ut-issl/c2a-core/releases/tag/v3.9.0)
- [v3.8.0](https://github.com/ut-issl/c2a-core/releases/tag/v3.8.0)
- [v3.7.0](https://github.com/ut-issl/c2a-core/releases/tag/v3.7.0)
- [v3.6.0](https://github.com/ut-issl/c2a-core/releases/tag/v3.6.0)
- [v3.5.0](https://github.com/ut-issl/c2a-core/releases/tag/v3.5.0)
- [v3.4.0](https://github.com/ut-issl/c2a-core/releases/tag/v3.4.0)
- [v3.1.1](https://github.com/ut-issl/c2a-core/releases/tag/v3.3.1)
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
## ドキュメント
- ドキュメント: https://github.com/arkedge/c2a-core/tree/develop/docs
- リファレンス (TBD): https://github.com/ut-issl/c2a-reference
- [CHANGELOG](./CHANGELOG.md)


## 開発
Expand Down

0 comments on commit fc5702a

Please sign in to comment.