diff --git a/process/folder_templates/modules/module_name/docs/release/release_note.rst b/process/folder_templates/modules/module_name/docs/release/release_note.rst index 728108b2d0..fb6c5d3944 100644 --- a/process/folder_templates/modules/module_name/docs/release/release_note.rst +++ b/process/folder_templates/modules/module_name/docs/release/release_note.rst @@ -35,94 +35,86 @@ Release Note -| Module Name: [Module Name] -| 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 software module release version vX.Y.Z -| as compared to the module's 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 as the 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. -| -| Other changes by Label -| ---------------------- -| -| - **Label 1/Refactor 1**: Brief description of the change. -| - **Label 2/Refactor 2**: Brief description of the change. -| - **Label 3/Refactor 3**: Brief description of the change. -| -| Compatibility -| ------------- -| -| - **Dependencies**: List any dependencies and their versions. -| -| Performed Verification -| ---------------------- -| This release note is based on the verification as documented in module verification report -| :need:`doc__module_name_verification_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. -| -| Contributors -| ------------ -| -| Thanks to everyone who contributed to this release: -| -| Contributor 1 -| Contributor 2 -| -| Contact Information -| ------------------- -| -| For any questions or support, please contact the *Project lead* or raise an issue/discussion. +| **Module Name:** [Module Name] +| **Release Tag:** vX.Y.Z +| **Origin Release Tag:** vU.V.W +| **Release Date:** YYYY-MM-DD + + +Overview +^^^^^^^^ + +This document provides an overview of the changes, improvements, and bug fixes included in the software module release version vX.Y.Z +as compared to the module's 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 as the project, +being a non-profit and open source organization, can not take over any liability for its content. + +Changes to the Module +^^^^^^^^^^^^^^^^^^^^^ + +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. + +Other changes by Label +---------------------- + +- **Label 1/Refactor 1:** Brief description of the change. +- **Label 2/Refactor 2:** Brief description of the change. +- **Label 3/Refactor 3:** Brief description of the change. + +Compatibility +^^^^^^^^^^^^^ + +- **Dependencies:** List any dependencies and their versions. + +Performed Verification +^^^^^^^^^^^^^^^^^^^^^^ + +This release note is based on the verification as documented in module verification report +:need:`doc__module_name_verification_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. + +For any questions or support, please contact the *Project lead* or raise an issue/discussion. diff --git a/process/folder_templates/platform/docs/release/release_note.rst b/process/folder_templates/platform/docs/release/release_note.rst index 6e6d134d35..ac7f332b71 100644 --- a/process/folder_templates/platform/docs/release/release_note.rst +++ b/process/folder_templates/platform/docs/release/release_note.rst @@ -32,90 +32,90 @@ Platform Release Note - Adjust ``safety`` and ``tags`` according to your needs +| **Platform Name:** +| **Release Tag:** vX.Y.Z +| **Origin Release Tag:** vU.V.W +| **Release Date:** YYYY-MM-DD -| 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 software platform release version vX.Y.Z -| as compared to the platform's 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 as the 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. -| -| Other changes by Label -| ---------------------- -| -| - **Label 1/Refactor 1**: Brief description of the change. -| - **Label 2/Refactor 2**: Brief description of the change. -| - **Label 3/Refactor 3**: Brief description of the change. -| -| Compatibility -| ------------- -| -| - **Dependencies**: List any dependencies and their versions. -| -| Performed Verification -| ---------------------- -| This release note is based on the verification as documented in platform verification report -| :need:`doc__platform_verification_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. -| -| Contributors -| ------------ -| -| Thanks to everyone who contributed to this release: -| -| Contributor 1 -| Contributor 2 -| +Overview +^^^^^^^^ + +This document provides an overview of the changes, improvements, and bug fixes included in the software platform release version vX.Y.Z +as compared to the platform's 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 as the project, +being a non-profit and open source organization, can not take over any liability for its content. + +Changes to the Platform +^^^^^^^^^^^^^^^^^^^^^^^ + +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. + +Other changes by Label +---------------------- + +- **Label 1/Refactor 1:** Brief description of the change. +- **Label 2/Refactor 2:** Brief description of the change. +- **Label 3/Refactor 3:** Brief description of the change. + +Platform Scope +^^^^^^^^^^^^^^ + +- **Version:** +- **Source / tag:** +- **Release notes:** + +Integrated Software Modules +--------------------------- + + +~~~~~~~~~~~~~ + + + +- **Version:** +- **Source / tag:** +- **Release notes:** + + +Compatibility +^^^^^^^^^^^^^ + +- **Dependencies:** List any dependencies and their versions. + +Performed Verification +^^^^^^^^^^^^^^^^^^^^^^ + +This release note is based on the verification as documented in platform verification report +:need:`doc__platform_verification_report`. + +Known Issues/Vulnerabilities and Bug Fixes +------------------------------------------ + +- see release notes of every module separately + + +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. + +For any questions or support, please contact the *Project lead* or raise an issue/discussion.