From 955453962fe8a933c0d9957af1114c5807eb8fa3 Mon Sep 17 00:00:00 2001 From: Theresa Hilger <84102125+ther3sa@users.noreply.github.com> Date: Tue, 8 Oct 2024 17:40:22 +0200 Subject: [PATCH] docs: update product release issue template (#813) * Remove the checks Interoperability and Data Sovereignty * Remove Threat Modeling * Add feature section to description * Add summary section to description * delete tasklist for feature and add note for feature * Add empty line for features and summary for proper md format * adapt QGate issue, add needed content * add contacts for release * Update content based on discusions * Update .github/ISSUE_TEMPLATE/3_product_release_checks.md Co-authored-by: Evelyn Gurschler * Update .github/ISSUE_TEMPLATE/3_product_release_checks.md Co-authored-by: Evelyn Gurschler * Delete documentation section and user journey * Change responsible contacts: technical to contributor --------- Co-authored-by: Stephan Bauer Co-authored-by: Evelyn Gurschler --- .../3_product_release_checks.md | 91 +++++++++++++++---- 1 file changed, 75 insertions(+), 16 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/3_product_release_checks.md b/.github/ISSUE_TEMPLATE/3_product_release_checks.md index 1777378f..9108b306 100644 --- a/.github/ISSUE_TEMPLATE/3_product_release_checks.md +++ b/.github/ISSUE_TEMPLATE/3_product_release_checks.md @@ -4,8 +4,11 @@ about: Use this template to track all release checks for your component title: "[Product] Release Checks" --- -> [!IMPORTANT] -> Follow the [guidance on how to use the templates](https://github.com/eclipse-tractusx/sig-release/blob/main/README.md#release-management-acceptance-criteria). + ## Release Info @@ -13,19 +16,24 @@ Please provide information on what you want to be included in the Eclipse Tractu If you are not owner of this issue, please provide the information as comment to the issue. Make sure to assign this issue to expert(s) for their approval, as soon as you have finished preparation. Multiple assignees allowed; they will un-assign themselves once review completed. -**Version to be included in Eclipse Tractus-X release**: *version placeholder* +**Responsible contacts**: + +- Committer: *GitHub handle* +- ExpertGroup: *GitHub handle* +- Contributor contact: *GitHub handle* -**Leading product repository:** *repository link* - -# Compliance Verifications +**Version to be included in Eclipse Tractus-X release**: + -This issue tracks all checks, that need to be performed for a product release in Eclipse Tractus-X. +- App version: *version placeholder* +- Helm Chart version: *version placeholder* -- [ ] **Interoperability** checks performed -- [ ] **Data Sovereignty** checks performed +**Leading product repository:** *repository link* -# General Checks +## Compliance + +- [ ] Possible changes (through the new features) on related Catena-X standards are considered and addressed - [ ] [**Tractus-X Release Guidelines**](https://eclipse-tractusx.github.io/docs/release)(TRGs) fulfilled Make sure to open and fill in a separate **documentation issue** in your product repository using the [Quality Gate Checklist issue template](https://github.com/eclipse-tractusx/.github/blob/main/.github/ISSUE_TEMPLATE/qg-checklist.md) @@ -33,15 +41,66 @@ Make sure to open and fill in a separate **documentation issue** in your product > [!NOTE] > Note: most criteria for documentation and security are now covered in TRGs -# Security Checks +## Functionality + + +- [ ] Feature works as expected and described +- [ ] Backward compatibility maintained (depending Major/ Minor) + +## Performance + + +- [ ] Memory and CPU usage is within acceptable limits oriented with goldilocks + +## Testing + + +- [ ] Unit tests cover all new features +- [ ] Integration tests are updated +- [ ] E2E/Integration test passed +- [ ] Regressions tests passed + +## Feature summary + + +Please provide a list of all features that have been developed in the current phase. This list is essential for several reasons: + +- **Test Preparation:** Identifying new features will help in the creation of new end-to-end (E2E) tests and ensure that the relevant aspects are thoroughly tested. +- **Awareness:** It will raise awareness of the features that need to be prioritized during the testing process. +- **Board Management:** This will assist in keeping the project board organized and up-to-date. + +By documenting these features, you will contribute to a smoother and more efficient release process. + +> [!NOTE] +> Note: all features needs to be closed to get approval for release + +| Feature | Test Status | Note | +|----------|----------|----------| +| linked feature 1 | Test status | note 1 | +| linked feature 2 | Test status | note 2 | +| linked feature 3 | Test status | note 3 | + +## Release Documentation + + +- [ ] Release notes/Changelogs are updated +- [ ] Migration scripts/documentation are included if necessary (Ensure that any database or infrastructure migrations are included). +- [ ] Known knowns + - topic 1 + - topic 2 -- [ ] **Threat Modeling Analysis** passed +## Summary + -# Test Results +Please provide a short summary about the new values/benefits of the new features here: -- [ ] **E2E Integration Test** passed -- [ ] **User Journey** approved +- description of the value of feature 1 +- description of the value of feature 2 -# Helpful Links +## Helpful Links - [Eclipse Tractus-X openAPI specs on SwaggerHub](https://app.swaggerhub.com/search?owner=eclipse-tractusx-bot)