Skip to content

Audit action correction release mgt #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aschemmel-tech merged 1 commit into from
Jul 7, 2025
Merged

Audit action correction release mgt #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion process/folder_templates/modules/module_name/docs/release/release_note.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,15 @@ Release Note

| Module Name: [Module Name]
| Release Tag: vX.Y.Z
| Origin Release Tag: vU.V.W

@masc2023 masc2023 Jul 4, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Definition Origin Release unclear for me, do you mean first release ever or just previous release, in GitHub the changes are only shown to previous release, e.g. https://github.com/eclipse-score/process_description/releases

@aschemmel-tech aschemmel-tech Jul 7, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a remark on this to the templates.

| 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
| ------------
Expand Down Expand Up @@ -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
| ------------
|
Expand Down
1 change: 1 addition & 0 deletions process/process_areas/release_management/guidance/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,4 @@ Guidance

release_guideline
release_templates
release_process_reqs
8 changes: 4 additions & 4 deletions process/process_areas/release_management/guidance/release_guideline.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**:
Expand Down Expand Up @@ -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.
Expand All @@ -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 <REPLACE_doc__project_mgt_plan>`.
* meeting definition and schedule is defined in the projects's platform managemnt plan, as defined in :need:`gd_guidl__platform__mgmt_plan`.


Templates
Expand Down
26 changes: 26 additions & 0 deletions process/process_areas/release_management/guidance/release_process_reqs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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`.
9 changes: 8 additions & 1 deletion process/process_areas/release_management/guidance/release_templates.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
| ------------
Expand All @@ -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
| <add link here> (report derived from template :need:`gd_temp__platform_ver_report`).
|
| Known Issues
| ------------
| - **Issue 1**: Brief description of the known issue. Justification regarding safety impact.
Expand Down