Skip to content

Commit c0d9c77

Browse files
Audit action correction: release no production
Ref: Resolves #89
1 parent 5bce5ca commit c0d9c77

File tree

3 files changed

+26
-10
lines changed

3 files changed

+26
-10
lines changed

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,12 @@ Release Note
4646
| This document provides an overview of the changes, improvements, and bug fixes included in the software module release version vX.Y.Z
4747
| as compared to the module's origin release (which is usually the previous release).
4848
|
49+
| Disclaimer
50+
| ----------
51+
| This release note does not "release for production", as it does not come with a safety argumentation and a performed safety assessment.
52+
| The work products compiled in the safety package are created with care according to a process satisfying standards, but the S-CORE project,
53+
| being a non-profit and open source organization, can not take over any liability for its content.
54+
|
4955
| New Features
5056
| ------------
5157
|

process/process_areas/release_management/guidance/release_guideline.rst

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Guideline
1818
.. gd_guidl:: Release Management Guideline
1919
:id: gd_guidl__rel_management
2020
:status: valid
21-
:complies: std_req__iso26262__management_64131, std_req__iso26262__management_64132, std_req__iso26262__management_64133, std_req__iso26262__management_64135
21+
:complies: std_req__iso26262__management_64131, std_req__iso26262__management_64132, std_req__iso26262__management_64133, std_req__iso26262__management_64134, std_req__iso26262__management_64135
2222

2323
.. _workflow_release:
2424

@@ -27,7 +27,7 @@ Software Module Release
2727

2828
1. **Repository Management**:
2929

30-
* Each software module is contained in its own GitHub repository.
30+
* Each software module is contained in its own repository.
3131
* Ensure that the repository follows the standard naming conventions and structure.
3232

3333
2. **Release Planning**:
@@ -46,13 +46,15 @@ Software Module Release
4646

4747
* 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+
* Check if all planned documents and work products are in valid state.
4950
* Ensure the module's safety package is available and complete.
50-
* Tag the release in the GitHub repository.
51+
* Tag the release in the repository.
5152

5253
5. **Release Execution**:
5354

54-
* Create a release in the GitHub repository release branch and attach the release notes. For this consider the `GitHub Howto Release <https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository/>`_
55+
* Create a release in the repository release branch and attach the release notes. For this consider the `Howto Release <https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository/>`_
5556
* Notify the project lead circle about the release for approval.
57+
* One of the project leads will give a review approval for the release note in the versioning tool, which is equivalent to his signing the release.
5658

5759

5860
Platform Release
@@ -81,13 +83,15 @@ Platform Release
8183
* Check if modules are released.
8284
* Update the platform version number according to the versioning policy (defined in release management part of the :need:`gd_temp__platform__mgmt_plan`).
8385
* Prepare platform release notes summarizing the updates from all integrated software modules.
86+
* Check if all planned documents and work products are in valid state.
8487
* Ensure the relevant safety packages are available and complete.
85-
* Tag the platform release in the GitHub repository.
88+
* Tag the platform release in the repository.
8689

8790
5. **Release Execution**:
8891

89-
* Create a release in the GitHub repository release branch and attach the platform release notes. For this consider the `GitHub Howto Release <https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository/>`_
92+
* Create a release in the repository release branch and attach the platform release notes. For this consider the `Howto Release <https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository/>`_
9093
* Notify the project lead circle about the release for approval.
94+
* One of the project leads will give a review approval for the release note in the versioning tool, which is equivalent to his signing the release.
9195
* Publish within Eclipse SDV.
9296

9397

@@ -96,7 +100,7 @@ Tracking and Communication
96100

97101
1. **Tracking**:
98102

99-
* Use the github project management tools to track the progress of software module releases and the platform release.
103+
* Use the project management tools to track the progress of software module releases and the platform release.
100104
* Maintain a release calendar to visualize the timelines and milestones.
101105

102106
2. **Communication**:

process/process_areas/release_management/guidance/release_templates.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,12 @@ Templates
3232
| This document provides an overview of the changes, improvements, and bug fixes included in the platform release version vX.Y.Z
3333
| as compared to the platform origin release (which is usually the previous release).
3434
|
35+
| Disclaimer
36+
| ----------
37+
| This release note does not "release for production", as it does not come with a safety argumentation and a performed safety assessment.
38+
| The work products compiled in the safety package are created with care according to a process satisfying standards, but the S-CORE project,
39+
| being a non-profit and open source organization, can not take over any liability for its content.
40+
|
3541
| New Features
3642
| ------------
3743
| - **Feature 1**: Brief description of the new feature.
@@ -99,10 +105,10 @@ Templates
99105
| -------------------------------------------------------
100106
|
101107
| 1. Link this issue to the correct milestone and assign to the technical lead
102-
| 2. Check respective Verification report on the release candidate's github tag
108+
| 2. Check respective Verification report on the release candidate's baseline
103109
| 3. Check bugfixes or justify failed tests
104110
| 4. Check the safety package completeness (includes "valid" documents and work products status, supported by the safety manager)
105111
| 5. Create/update the release note (pull request to close this issue)
106-
| 6. Document safety manager's "recommendation to release" by asking his GitHub review approval of the release note
107-
| 7. Create the "release" in GitHub according to :need:`gd_guidl__rel_management`
112+
| 6. Document project manager's consent by asking review approval of the release note
113+
| 7. Create the "release" in version management tool according to :need:`gd_guidl__rel_management`
108114
| 8. Merge PR and close this issue to complete the release

0 commit comments

Comments
 (0)