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 80682eb639..ba4e38cd37 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 @@ -36,13 +36,15 @@ 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 | | Overview | -------- | -| This document provides an overview of the changes, improvements, and bug fixes included in the software module release version vX.Y.Z. +| 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). | | New Features | ------------ @@ -70,6 +72,11 @@ Release Note | | - **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 | ------------ | diff --git a/process/process_areas/release_management/guidance/index.rst b/process/process_areas/release_management/guidance/index.rst index 819bcbb8b8..2c5f0a1690 100644 --- a/process/process_areas/release_management/guidance/index.rst +++ b/process/process_areas/release_management/guidance/index.rst @@ -20,3 +20,4 @@ Guidance release_guideline release_templates + release_process_reqs diff --git a/process/process_areas/release_management/guidance/release_guideline.rst b/process/process_areas/release_management/guidance/release_guideline.rst index 9e735b94e6..1bfe7374d4 100644 --- a/process/process_areas/release_management/guidance/release_guideline.rst +++ b/process/process_areas/release_management/guidance/release_guideline.rst @@ -44,9 +44,9 @@ Software Module Release 4. **Release Preparation**: - * Update the version number according to the versioning policy (defined in `REPLACE_doc__platform_release_management_plan`). + * Update the version number according to the versioning policy of your module (defined in release management part of the :need:`gd_temp__platform__mgmt_plan`). * Prepare release notes documenting the changes, improvements, and bug fixes. - * Ensure the relevant safety packages are available and complete. + * Ensure the module's safety package is available and complete. * Tag the release in the GitHub repository. 5. **Release Execution**: @@ -79,7 +79,7 @@ Platform Release 4. **Release Preparation**: * Check if modules are released. - * Update the platform version number according to the versioning policy (defined in `REPLACE_doc__platform_release_management_plan`). + * Update the platform version number according to the versioning policy (defined in release management part of the :need:`gd_temp__platform__mgmt_plan`). * Prepare platform release notes summarizing the updates from all integrated software modules. * Ensure the relevant safety packages are available and complete. * Tag the platform release in the GitHub repository. @@ -103,7 +103,7 @@ Tracking and Communication * Regularly update all stakeholders on the release status as part of the project lead circle. * Hold periodic meetings to discuss progress, issues, and dependencies within the tech lead circle. - * meeting definition and schedule see `Steering committees `. + * meeting definition and schedule is defined in the projects's platform managemnt plan, as defined in :need:`gd_guidl__platform__mgmt_plan`. Templates diff --git a/process/process_areas/release_management/guidance/release_process_reqs.rst b/process/process_areas/release_management/guidance/release_process_reqs.rst new file mode 100644 index 0000000000..feb7281e3f --- /dev/null +++ b/process/process_areas/release_management/guidance/release_process_reqs.rst @@ -0,0 +1,26 @@ +.. + # ******************************************************************************* + # Copyright (c) 2025 Contributors to the Eclipse Foundation + # + # See the NOTICE file(s) distributed with this work for additional + # information regarding copyright ownership. + # + # This program and the accompanying materials are made available under the + # terms of the Apache License Version 2.0 which is available at + # https://www.apache.org/licenses/LICENSE-2.0 + # + # SPDX-License-Identifier: Apache-2.0 + # ******************************************************************************* + +Process Requirements +==================== + +.. gd_req:: Release note automated generation + :id: gd_req__release__note + :status: valid + :tags: prio_2_automation, release_management + :satisfies: wf__rel__platform_rel_note, wf__rel__mod_rel_note + :complies: std_req__iso26262__management_64134, std_req__iso26262__management_64135, std_req__aspice_40__SUP-8-BP7 + + | The release note shall be generated progressively and automatically compiling the content as far as possible. + | This shall be done according to templates :need:`gd_temp__rel__plat_rel_note` and :need:`gd_temp__rel__mod_rel_note`. diff --git a/process/process_areas/release_management/guidance/release_templates.rst b/process/process_areas/release_management/guidance/release_templates.rst index c451cd37a3..3f180bde99 100644 --- a/process/process_areas/release_management/guidance/release_templates.rst +++ b/process/process_areas/release_management/guidance/release_templates.rst @@ -23,12 +23,14 @@ Templates | Platform Release Notes | ====================== | Release Tag: vX.Y.Z + | Origin Release Tag: vU.V.W | Release Commit Hash: a1b2c3d4e5f6g7h8i9j0 | Release Date: YYYY-MM-DD | | Overview | -------- - | This document provides an overview of the changes, improvements, and bug fixes included in the platform release version vX.Y.Z. + | 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). | | New Features | ------------ @@ -54,6 +56,11 @@ Templates | - **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 + | (report derived from template :need:`gd_temp__platform_ver_report`). + | | Known Issues | ------------ | - **Issue 1**: Brief description of the known issue. Justification regarding safety impact.