Templates#
Platform Release Note Template
|
status: valid
|
||||
Platform Release Notes
======================
Release Tag: vX.Y.Z
Origin Release Tag: vU.V.W
Release Commit Hash: a1b2c3d4e5f6g7h8i9j0
Release Date: YYYY-MM-DD
Safety: [QM | ASIL_B]
Security: [NO | YES]
Overview
——–
This document provides an overview of the changes, improvements, and bug fixes included in the platform release version vX.Y.Z
as compared to the platform origin release (which is usually the previous release).
Disclaimer
———-
This release note does not “release for production”, as it does not come with a safety argumentation and a performed safety assessment.
The work products compiled in the safety package are created with care according to a process satisfying standards, but the <e.g. S-CORE> project,
being a non-profit and open source organization, can not take over any liability for its content.
New Features
————
- Feature 1: Brief description of the new feature.
- Feature 2: Brief description of the new feature.
- Feature 3: Brief description of the new feature.
Improvements
————
- Improvement 1: Brief description of the improvement.
- Improvement 2: Brief description of the improvement.
- Improvement 3: Brief description of the improvement.
Bug Fixes
———
- Bug 1: Brief description of the bug fix.
- Bug 2: Brief description of the bug fix.
- Bug 3: Brief description of the bug fix.
Integrated Software Modules
—————————
- Module 1: Version and brief description of the module. Link to Software module release note.
- Module 2: Version and brief description of the module. Link to Software module release note.
- Module 3: Version and brief description of the module. Link to Software module release note.
Performed Verification
———————-
This release note is based on the verification as documented in platform verification report
<add link here> (report derived from template Platform Verification Repor... (gd_temp__platform_ver_report)).
Known Issues
————
- Issue 1: Brief description of the known issue. Justification regarding safety impact.
- Issue 2: Brief description of the known issue. Justification regarding safety impact.
- Issue 3: Brief description of the known issue. Justification regarding safety impact.
Known Vulnerabilities
———————
- CVE 1: Brief description of the known CVE. Justification regarding security impact.
- CVE 2: Brief description of the known CVE. Justification regarding security impact.
- CVE 3: Brief description of the known CVE. Justification regarding security impact.
Upgrade Instructions
——————–
1. Step 1: Description of the first step.
2. Step 2: Description of the second step.
3. Step 3: Description of the third step.
Contact Information
——————-
For any questions or support, please contact the Project Lead or raise an issue/discussion.
|
|||||
Module Release Note Template
|
status: valid
|
||||
For the content see here: [Your Module Name] Release ... (doc__module_name_release_note) |
|||||
Release Issue Template
|
status: valid
|
||||
Copy the below steps into the release ticket:
Release <add version number> for <platform/module_name>
——————————————————-
1. Link this issue to the correct milestone and assign to a project/module lead
2. Check respective Verification report on the release candidate’s baseline
3. Check bugfixes or justify failed tests
4. Check the safety package completeness (includes “valid” documents and work products status, supported by the safety manager)
5. Create/update the release note (pull request to close this issue)
6. Document project manager’s consent by asking review approval of the release note
7. Create the “release” in version management tool according to Release Management Guideline (gd_guidl__rel_management)
8. Merge PR and close this issue to complete the release
|
|||||