Release Notes¶

Contents:

Creation¶

To auto create and manage release notes please follow the following steps:

Download the template of release notes here: Release notes template.
Please follow the instructions given in the file and create your release notes. You can check out the sample here Sample Release Notes.

Warning

All packages/components from 0.18 onwards MUST have release notes for them. Without release notes they will not build.

This is not applicable to packages built before 0.18 and which are marked to be used for 0.18.
It will still work if you build a 0.18 package with only one component with version greater than 0.18 and other being an older component would still work.
If the version defined for component is not a valid format (Valid format - MM.mm.*) then it needs to have release notes. For example, IHUB has versions that do follow this methodology.
Please see below for some valid scenarios.

At ECU level, this is formatted a little cleaner.
At domain level, the ECU level information is thrown out. We get a list that is then showing what the domain changes are by ECU.
At the vehicle level, the Domain level information is thrown out. We get a list of what has changed by domain and by ECU.

Batt12V package built for 00.13 with no release note, is marked to be usable for 00.18.
BPG package built for 00.18 with BPG_APP version as 00.18 with release note and BPG_BLU version as 00.16 and no release note.
IHUB package built for their version style, needs to always have release notes for each component.

BPG package built for 00.18 with BPG_APP version as 00.18 with release note and BPG_BLU version as 00.18 and no release note.
IHUB package built for their version style, with any component with no release note.
BPG package built for 00.18 with BPG_APP version as 00.18 and version in release note txt file to be different than 00.18