Skip to content

Commit defe157

Browse files
Audit action correction release mgt
Ref: Resolves #89
1 parent fa3a308 commit defe157

File tree

5 files changed

+47
-6
lines changed

5 files changed

+47
-6
lines changed

process/folder_templates/modules/module_name/docs/release/release_note.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,15 @@ Release Note
3636

3737
| Module Name: [Module Name]
3838
| Release Tag: vX.Y.Z
39+
| Origin Release Tag: vU.V.W
3940
| Release Commit Hash: a1b2c3d4e5f6g7h8i9j0
4041
| Release Date: YYYY-MM-DD
4142
|
4243
| Overview
4344
| --------
4445
|
45-
| This document provides an overview of the changes, improvements, and bug fixes included in the software module release version vX.Y.Z.
46+
| This document provides an overview of the changes, improvements, and bug fixes included in the software module release version vX.Y.Z
47+
| as compared to the module's origin release.
4648
|
4749
| New Features
4850
| ------------
@@ -70,6 +72,11 @@ Release Note
7072
|
7173
| - **Dependencies**: List any dependencies and their versions.
7274
|
75+
| Performed Verification
76+
| ----------------------
77+
| This release note is based on the verification as documented in module verification report
78+
| :need:`doc__module_name_verification_report`.
79+
|
7380
| Known Issues
7481
| ------------
7582
|

process/process_areas/release_management/guidance/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,4 @@ Guidance
2020

2121
release_guideline
2222
release_templates
23+
release_process_reqs

process/process_areas/release_management/guidance/release_guideline.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ Software Module Release
4444

4545
4. **Release Preparation**:
4646

47-
* Update the version number according to the versioning policy (defined in `REPLACE_doc__platform_release_management_plan`).
47+
* 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`).
4848
* Prepare release notes documenting the changes, improvements, and bug fixes.
49-
* Ensure the relevant safety packages are available and complete.
49+
* Ensure the module's safety package is available and complete.
5050
* Tag the release in the GitHub repository.
5151

5252
5. **Release Execution**:
@@ -79,7 +79,7 @@ Platform Release
7979
4. **Release Preparation**:
8080

8181
* Check if modules are released.
82-
* Update the platform version number according to the versioning policy (defined in `REPLACE_doc__platform_release_management_plan`).
82+
* Update the platform version number according to the versioning policy (defined in release management part of the :need:`gd_temp__platform__mgmt_plan`).
8383
* Prepare platform release notes summarizing the updates from all integrated software modules.
8484
* Ensure the relevant safety packages are available and complete.
8585
* Tag the platform release in the GitHub repository.
@@ -103,7 +103,7 @@ Tracking and Communication
103103

104104
* Regularly update all stakeholders on the release status as part of the project lead circle.
105105
* Hold periodic meetings to discuss progress, issues, and dependencies within the tech lead circle.
106-
* meeting definition and schedule see `Steering committees <REPLACE_doc__project_mgt_plan>`.
106+
* meeting definition and schedule is defined in the projects's platform managemnt plan, as defined in :need:`gd_guidl__platform__mgmt_plan`.
107107

108108

109109
Templates
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
..
2+
# *******************************************************************************
3+
# Copyright (c) 2025 Contributors to the Eclipse Foundation
4+
#
5+
# See the NOTICE file(s) distributed with this work for additional
6+
# information regarding copyright ownership.
7+
#
8+
# This program and the accompanying materials are made available under the
9+
# terms of the Apache License Version 2.0 which is available at
10+
# https://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# SPDX-License-Identifier: Apache-2.0
13+
# *******************************************************************************
14+
15+
Process Requirements
16+
====================
17+
18+
.. gd_req:: Release note automated generation
19+
:id: gd_req__release__note
20+
:status: valid
21+
:tags: prio_2_automation, release_management
22+
:satisfies: wf__rel__platform_rel_note, wf__rel__mod_rel_note
23+
:complies: std_req__iso26262__management_64134, std_req__iso26262__management_64135, std_req__aspice_40__SUP-8-BP7
24+
25+
| The release note shall be generated progressively and automatically compiling the content as far as possible.
26+
| This shall be done according to templates :need:`gd_temp__rel__plat_rel_note` and :need:`gd_temp__rel__mod_rel_note`.

process/process_areas/release_management/guidance/release_templates.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,14 @@ Templates
2323
| Platform Release Notes
2424
| ======================
2525
| Release Tag: vX.Y.Z
26+
| Origin Release Tag: vU.V.W
2627
| Release Commit Hash: a1b2c3d4e5f6g7h8i9j0
2728
| Release Date: YYYY-MM-DD
2829
|
2930
| Overview
3031
| --------
31-
| This document provides an overview of the changes, improvements, and bug fixes included in the platform release version vX.Y.Z.
32+
| This document provides an overview of the changes, improvements, and bug fixes included in the platform release version vX.Y.Z
33+
| as compared to the platform origin release.
3234
|
3335
| New Features
3436
| ------------
@@ -54,6 +56,11 @@ Templates
5456
| - **Module 2**: Version and brief description of the module. Link to Software module release note.
5557
| - **Module 3**: Version and brief description of the module. Link to Software module release note.
5658
|
59+
| Performed Verification
60+
| ----------------------
61+
| This release note is based on the verification as documented in platform verification report
62+
| <add link here> (report derived from template :need:`gd_temp__platform_ver_report`).
63+
|
5764
| Known Issues
5865
| ------------
5966
| - **Issue 1**: Brief description of the known issue. Justification regarding safety impact.

0 commit comments

Comments
 (0)