Skip to content

Commit a50ce98

Browse files
authored
Merge pull request #87 from OpenSimulationInterface/build/add-release-notes-380
Add release notes for OSI v3.8.0 candidate
2 parents 53f19d6 + 5ad8aa7 commit a50ce98

5 files changed

Lines changed: 67 additions & 2 deletions

File tree

.antora/antora.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ version:
1111
v(*): V$1
1212
V(*): V$1
1313
# Update version number accordingly. This is the version for any other activated branch (branch must be added in the generator site.yml!). Schema = 0.0.x-<branch-name> (only works for branches starting with "feature/")
14-
(*): 'V3.6.0-$1'
14+
(*): 'V3.7.0-$1'
1515
# CENTRAL DOCUMENT ONLY!!! First page of the component. Define only once per component!
1616
start_page: specification:index.adoc
1717

.antora/modules/specification/nav_contribution.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@
5050
[appendix]
5151
* Release Notes
5252
53+
:sectnums!:
54+
** xref:appendix/releases/v03.08.adoc[]
5355
:sectnums!:
5456
** xref:appendix/releases/v03.07.adoc[]
5557
:sectnums!:
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
ifndef::include-only-once[]
2+
:root-path: ../../
3+
include::{root-path}_config.adoc[]
4+
endif::[]
5+
ifdef::use-antora-rules[]
6+
:reftext: v3.8.0 - OSI "Krisp Kobayashi"
7+
= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.8.0-prerc1[{reftext}]
8+
endif::[]
9+
ifndef::use-antora-rules[]
10+
= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.8.0-prerc1[v3.8.0 - OSI "Krisp Kobayashi"]
11+
endif::[]
12+
13+
Pole P(OSI)tion!
14+
15+
*Purpose*
16+
17+
//tag::content[]
18+
19+
## Pole P(OSI)tion!
20+
21+
This is a release candidate of OSI, not an official release. If no final changes are needed, it might be promoted to an official release upon confirmation by the ASAM TSC.
22+
23+
## Purpose
24+
25+
This minor release contains a number of incremental enhancements and improvements:
26+
27+
- The core OSI protobuf definitions and the language-specific bindings and modules have been split out to separate repositories, allowing easier maintenance and evolution of language-specific features.
28+
- New multi-channel trace file format based on MCAP for easier data storage and interchange
29+
- Adopted the ASAM OpenX harmonized vehicle types
30+
- Added tail light to vehicle classification/light state
31+
- Added model_reference attribute to RoadMarking
32+
- Added road type to logical lanes
33+
- Improved python bindings via pyi_out option of protoc
34+
- Various improvements to OSI rule definitions for new qc-osi-trace checker bundle
35+
- Improved specification of BaseMoving reference system
36+
- Added documentation of Tait-Bryan convention and quaternion formula
37+
38+
Beyond that, many clarifications, improvements in definitions and documentation, enhanced installation information and enhanced Python support, including provisioning of Python packages on PyPI are key improvements in this release.
39+
40+
*https://github.com/OpenSimulationInterface/open-simulation-interface/milestone/23?closed=1[Content/Changes]*
41+
42+
- Consolidate hosted osi documentation sources
43+
- Added missing pages and linked them in navigation
44+
- Fix open_simulation_interface-config.cmake.in
45+
- Add tail light to vehicle classification/light state
46+
- Add pyi_out option to protoc command in the setup.py
47+
- Initial multi channel trace file format specification
48+
- Add Tait-Bryan convention and quaternion formula to documentation
49+
- Add bibliography reference for MCAP
50+
- Adapt vehicle types from openx harmonization
51+
- Fix incorrect reference system documentation for detected objects in BaseMoving
52+
- Fix multiple rule bugs
53+
- Fix orientation3d formatting bug
54+
- Add new allowable rules minimum/maximum_length
55+
- Fix detection object reference rule
56+
- Update refers_to rule regex
57+
- Clarify protobuf version descriptions in documentation
58+
- Repository Split
59+
- Add model_reference attribute to RoadMarking
60+
- explain c++ and python repo split in documentation
61+
- Logical lanes: add road type
62+
//end::content[]

content/general_docs/changes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ include::{root-path}_config.adoc[]
44
endif::[]
55
= What has changed
66

7-
include::../appendix/releases/v03.07.adoc[tag=content]
7+
include::../appendix/releases/v03.08.adoc[tag=content]

content/index.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ include::./general_docs/bibliography.adoc[leveloffset=+1]
105105
== Release Notes
106106
:sectnums!:
107107

108+
include::./appendix/releases/v03.08.adoc[leveloffset=+2]
108109
include::./appendix/releases/v03.07.adoc[leveloffset=+2]
109110
include::./appendix/releases/v03.06.adoc[leveloffset=+2]
110111
include::./appendix/releases/v03.05.adoc[leveloffset=+2]

0 commit comments

Comments
 (0)