Skip to content

rework release templates #232

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

rework release templates #232

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
113 changes: 113 additions & 0 deletions .github/RELEASE_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
# *******************************************************************************
# 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
# *******************************************************************************

# Some portions generated by Co-Pilot

Copy link
Contributor

@pahmann pahmann Nov 5, 2025

Choose a reason for hiding this comment

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

There need to be the purpose of the release described. E.g. what is the safety level.
What is the release maturity: Ranging from only for testing in virtual environment up to production ready.
I assume this cannot be auto generated. So there might be the need by someone like a quality manager or project lead which gives an overall statement on the achieved quality.

We should consider a link to the user documentation of the released software as e.g. feature documentation within the feature repo.

Another point could be the external dependencies to other components.

Copy link
Contributor Author

@masc2023 masc2023 Nov 18, 2025

Choose a reason for hiding this comment

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

Please let's discuss about maturity in our meetings, not changed so far.

Copy link
Contributor

@pahmann pahmann Nov 5, 2025

Choose a reason for hiding this comment

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

Is it a good idea to have a disclaimer on what we promise and what not?

Copy link
Contributor Author

@masc2023 masc2023 Nov 18, 2025

Choose a reason for hiding this comment

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

added

# {{Platform | Module}} Release Note
**Release:** {{vX.Y.Z}}
**Origin Release:** {{vU.V.W}}
**Release Commit Hash:** a1b2c3d4e5f6g7h8i9j0
**Release Date:** {{YYYY-MM-DD}}
**Safety:** {{QM | ASIL_B}}
**Security:** {{NO | YES}}

## 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 <e.g. S-CORE> project, being a non-profit and open source organization, can not
take over any liability for its content.

---

## Overview
This document provides an overview of the changes, improvements, and bug fixes included
in the {{platform release version | software module release version vX.Y.Z}}
as compared to the {{platform | module}} origin release (which is usually the previous release).

<!-- List features added in this release -->
- {{FEATURE_REQUEST_1 | COMPONENT_REQUEST_1}} ({{PR_LINK}})
- {{FEATURE_REQUEST_2 | COMPONENT_REQUEST_2}} ({{PR_LINK}})

<!-- List improvements added in this release -->
- {{IMPROVEMENT_1}} ({{PR_LINK}})
- {{IMPROVEMENT_2}} ({{PR_LINK}})

---

## Contains

<!-- List dependencies for {{platform | module}} release -->
- {{Depends_1}} ({{Link to version}}), Brief description of the {{module | component}}.
- {{Depends_2}} ({{Link to version}}), Brief description of the {{module | component}}.

<!-- List documentation, code, tests, etc. added in this release -->
- {{Artifact_1}} ({{PR_LINK}})
- {{Artifact_2}} ({{PR_LINK}})

---

## Performed Verification
This release note is based on the verification as documented in {{platform | module}}
verification report <add link here> (report derived from template
:need:`gd_temp__platform_ver_report` | :need:`doc__module_name_verification_report`.)

---

## Bug Fixes

<!-- List bugs fixed in this release -->
- {{BUGFIX_1}} ([#{{PR_NUMBER}}]({{PR_LINK}}))
- {{BUGFIX_2}} ([#{{PR_NUMBER}}]({{PR_LINK}}))

<!-- List any breaking changes introduced -->
- {{BREAKING_CHANGE_1}} ({{PR_LINK}})
- {{BREAKING_CHANGE_2}} ({{PR_LINK}})

---

## Known Issues
- {{ISSUE_1}} ([#{{PR_NUMBER}}]({{PR_LINK}})), Brief description of the known issue. Justification regarding safety impact.
- {{ISSUE_2}} ([#{{PR_NUMBER}}]({{PR_LINK}})), Brief description of the known issue. Justification regarding safety impact.


## Known vulnerabilities (CVE)
- {{CVE_1}} ([#{{PR_NUMBER}}]({{PR_LINK}})), Brief description of the CVE. Justification regarding security impact.
- {{CVE_2}} ([#{{PR_NUMBER}}]({{PR_LINK}})), Brief description of the 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.

---

## Other Changes by Label

### Refactoring
- {{REFACTOR_1}} ([#{{PR_NUMBER}}]({{PR_LINK}}))
- {{REFACTOR_2}} ([#{{PR_NUMBER}}]({{PR_LINK}}))


## Contributors

Thanks to everyone who contributed to this release:

- @{{CONTRIBUTOR_1}}
- @{{CONTRIBUTOR_2}}

Copy link
Contributor

@pahmann pahmann Nov 5, 2025

Choose a reason for hiding this comment

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

This template misses know limitations which means relevant open issues. This is relevant for component, feature, and platform.
For platform level it needs to collect features.
For feature it needs to collect the component issues.

Explicit CVE report makes also sense as known limitations.
Same would make be helpful for safety.

Copy link
Contributor Author

@masc2023 masc2023 Nov 18, 2025

Choose a reason for hiding this comment

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

Template updated with missing information, but we have only platform and module releases, not more. CVE Section added

---

## Full Changelog
51 changes: 46 additions & 5 deletions .github/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,58 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

# Some portions generated by Co-Pilot

changelog:
categories:
- title: Feature overview
- title: Feature Overview
labels:
- feature_request
- feature_modification
- component_request
- enhancement
- title: Improvements & Modifications
labels:
- feature_modification
- component_modification
- title: What is included (documentation, code, tests, etc.) ?
- improvement
- title: Documentation Updates
labels:
- '*'
- title: Known limitations / Bugs
- documentation
- docs
- readme
- title: Bug Fixes
labels:
- bug
- bugfix
- fix
- title: Security Updates
labels:
- security
- vulnerability
- cve
- title: Breaking Changes
labels:
- breaking-change
- breaking
- major
- title: Dependencies
labels:
- dependencies
- deps
- dependency-update
- title: Testing & Quality
labels:
- test
- testing
- quality
- ci
- workflow
- title: Maintenance & Chores
labels:
- chore
- maintenance
- refactor
- cleanup
- title: Other Changes
labels:
- '*'
8 changes: 8 additions & 0 deletions 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 @@ -40,6 +40,8 @@ Release Note
| Origin Release Tag: vU.V.W
| Release Commit Hash: a1b2c3d4e5f6g7h8i9j0
| Release Date: YYYY-MM-DD
| Safety: [QM | ASIL_B]
| Security: [NO | YES]
|
| Overview
| --------
Expand Down Expand Up @@ -91,6 +93,12 @@ Release Note
| - **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
| --------------------
|
Expand Down
10 changes: 9 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 @@ -26,6 +26,8 @@ Templates
| Origin Release Tag: vU.V.W
| Release Commit Hash: a1b2c3d4e5f6g7h8i9j0
| Release Date: YYYY-MM-DD
| Safety: [QM | ASIL_B]
| Security: [NO | YES]
|
| Overview
| --------
Expand All @@ -35,7 +37,7 @@ Templates
| 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 S-CORE project,
| The work products compiled in the safety package are created with care according to a process satisfying standards, but the <e.g. S-CORE> project,
| being a non-profit and open source organization, can not take over any liability for its content.
|
| New Features
Expand Down Expand Up @@ -73,6 +75,12 @@ Templates
| - **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
| --------------------
|
Expand Down
5 changes: 3 additions & 2 deletions process/process_areas/release_management/release_getstrt.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,9 @@ Releases can be done in every repository, mainly:
* Platform (Main project/Integration) repository
* Module (platform's components) repositories

For this a templates :need:`gd_temp__rel_plat_rel_note` & :need:`gd_temp__rel_mod_rel_note`, guidelines
:need:`gd_guidl__rel_management` and a :need:`doc_concept__rel_process`
For this a templates :need:`gd_temp__rel_plat_rel_note` & :need:`gd_temp__rel_mod_rel_note`
or `Combined Release Template <https://github.com/eclipse-score/process_description/blob/main/.github/RELEASE_TEMPLATE.md>`_,
guidelines :need:`gd_guidl__rel_management` and a :need:`doc_concept__rel_process`
are available.

General Workflow
Expand Down
Loading