Skip to content

Commit 224d39d

Browse files
authored
docs: restructure changelog — restart versioning at v0.1.0 (#8)
Move all content accumulated since the project rename into v0.1.0. Preserve v1.0 and v2.0 under a clearly marked Legacy section. Add a note explaining the version restart and why the old releases are not upgrade-compatible with v0.1.0.
1 parent a1adf9f commit 224d39d

1 file changed

Lines changed: 63 additions & 24 deletions

File tree

documentation/changelog.rst

Lines changed: 63 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -14,51 +14,75 @@ Changelog & Release Notes
1414
Releases are listed newest-first. Unreleased work lives under
1515
:ref:`Unreleased <unreleased>` until it is tagged.
1616

17+
.. note::
18+
19+
Version numbering restarted at **v0.1.0** when the project was renamed
20+
and restructured as *Autoware Safety Island*. Legacy releases (v1.0,
21+
v2.0) from the previous project structure are preserved at the bottom of
22+
this page for historical reference.
23+
1724
.. _unreleased:
1825

19-
*************************
20-
Unreleased (since v2.0)
21-
*************************
26+
**********
27+
Unreleased
28+
**********
29+
30+
Nothing yet.
2231

23-
Major refactor: Autoware components are now vendored directly into the Zephyr
24-
application. The previous ``Actuation Service`` / ``Message Converter`` /
25-
``Actuation Player`` split has been retired, along with the separate Autoware
26-
workspace.
32+
*****
33+
v0.1.0
34+
*****
35+
36+
First release of *Autoware Safety Island*. Major restructuring from the
37+
previous project: Autoware components are now vendored directly into the
38+
application, the separate ``Actuation Service`` / ``Message Converter`` /
39+
``Actuation Player`` split has been retired, and a platform abstraction
40+
layer enables a FreeRTOS POSIX simulator alongside the Zephyr target.
2741

2842
New features
2943
============
3044

3145
- Direct integration of Autoware modules (MPC lateral, PID longitudinal,
32-
trajectory follower node) into the Zephyr application.
46+
trajectory follower node) compiled as part of the application.
3347
- ``fvp_baser_aemv8r_smp`` target for Arm Fixed Virtual Platform simulation.
34-
- AVH deployment flow via ``avh.py``, using the
35-
``aem8r64-lan9c111`` instance flavor.
36-
- Simplified top-level ``build.sh`` replaces the previous multi-step build.
48+
- ``s32z270dc2_rtu0_r52@D`` target for NXP S32Z270 hardware.
49+
- AVH deployment flow via ``avh.py``, using the ``aem8r64-lan9c111``
50+
instance flavor.
51+
- Simplified top-level ``build.sh`` replacing the previous multi-step build.
3752
- Platform abstraction layer (``actuation_module/include/platform/``) with
3853
Zephyr and FreeRTOS backends, keeping controller logic fully shared.
3954
- FreeRTOS POSIX simulator build (``actuation_module/freertos/``) using
4055
FreeRTOS-Kernel V11.1.0, buildable on any Linux host.
41-
- CI pipeline (``build-ci.yml``) verifying both Zephyr (FVP) and FreeRTOS
42-
simulator builds on every pull request and daily.
43-
- Release workflow (``release.yml``) publishing ``zephyr-fvp.elf``,
44-
``zephyr-s32z.elf``, ``actuation_freertos``, and ``sha256sums.txt`` on
45-
every ``v*.*.*`` tag.
56+
- CI pipeline verifying both Zephyr (FVP) and FreeRTOS simulator builds on
57+
every pull request and daily.
58+
- Release workflow publishing ``zephyr-fvp.elf``, ``zephyr-s32z.elf``,
59+
``actuation_freertos``, and ``sha256sums.txt`` on every ``v*.*.*`` tag.
4660

4761
Changed
4862
=======
4963

50-
- Removed the dependency on a separate Autoware workspace and pre-compiled
51-
binaries. Autoware components are now compiled as part of the Zephyr
52-
application.
64+
- Removed dependency on a separate Autoware workspace and pre-compiled
65+
binaries.
5366
- Replaced the ROS 2-based *Message Converter* and *Actuation Player* with
5467
direct DDS communication and integrated control logic.
55-
- ``network_config`` refactored from a header-only implementation to a
56-
proper declaration (``include/common/dds/network_config.hpp``) and
57-
Zephyr-only source file (``src/common/dds/network_config.cpp``), guarded
58-
by a compile-time error if included in non-Zephyr builds.
59-
- Devcontainer image moved to
68+
- ``network_config`` refactored from header-only to a proper declaration
69+
(``include/common/dds/network_config.hpp``) and Zephyr-specific source
70+
(``src/common/dds/network_config.cpp``).
71+
- Devcontainer image published at
6072
``ghcr.io/autowarefoundation/autoware-safety-island:devcontainer``.
6173

74+
Limitations
75+
===========
76+
77+
- A devicetree overlay at
78+
``actuation_module/boards/s32z270dc2_rtu0_r52@D.overlay`` is used as a
79+
workaround to set a unique MAC address for the NXP S32Z270DC2_R52 board,
80+
which otherwise reuses the same MAC on every build
81+
(tracked in `Zephyr Project #61478
82+
<https://github.com/zephyrproject-rtos/zephyr/issues/61478>`_).
83+
- FreeRTOS support is currently POSIX simulator only; real hardware port
84+
(Phases 5–6) is future work.
85+
6286
Third-party repositories
6387
========================
6488

@@ -75,6 +99,21 @@ Third-party repositories
7599
branch: main
76100
commit: 339cd5a45fd2ebba064ef462b71c657336ca0dfe
77101
102+
name: freertos-kernel
103+
url: https://github.com/FreeRTOS/FreeRTOS-Kernel.git
104+
tag: V11.1.0
105+
commit: dbf70559b27d39c1fdb68dfb9a32140b6a6777a0
106+
107+
.. _legacy:
108+
109+
*******************************
110+
Legacy releases (previous project structure)
111+
*******************************
112+
113+
The releases below predate the rename and restructuring to *Autoware Safety
114+
Island*. They are preserved here for historical reference only and are not
115+
upgrade-compatible with v0.1.0.
116+
78117
****
79118
v2.0
80119
****

0 commit comments

Comments
 (0)