From 7223dd59d098ac08807621c0615053abc723f53d Mon Sep 17 00:00:00 2001 From: Theresa Hilger <84102125+ther3sa@users.noreply.github.com> Date: Fri, 19 Jul 2024 17:02:23 +0200 Subject: [PATCH 01/13] Remove the checks Interoperability and Data Sovereignty --- .github/ISSUE_TEMPLATE/3_product_release_checks.md | 7 ------- 1 file changed, 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/3_product_release_checks.md b/.github/ISSUE_TEMPLATE/3_product_release_checks.md index 1777378f..f7a7ea3e 100644 --- a/.github/ISSUE_TEMPLATE/3_product_release_checks.md +++ b/.github/ISSUE_TEMPLATE/3_product_release_checks.md @@ -17,13 +17,6 @@ Make sure to assign this issue to expert(s) for their approval, as soon as you h **Leading product repository:** *repository link* -# Compliance Verifications - -This issue tracks all checks, that need to be performed for a product release in Eclipse Tractus-X. - -- [ ] **Interoperability** checks performed -- [ ] **Data Sovereignty** checks performed - # General Checks - [ ] [**Tractus-X Release Guidelines**](https://eclipse-tractusx.github.io/docs/release)(TRGs) fulfilled From 5fbabb306470e6ffe55bcc2da7c305d05cefc700 Mon Sep 17 00:00:00 2001 From: Theresa Hilger <84102125+ther3sa@users.noreply.github.com> Date: Fri, 19 Jul 2024 17:03:08 +0200 Subject: [PATCH 02/13] Remove Threat Modeling --- .github/ISSUE_TEMPLATE/3_product_release_checks.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/3_product_release_checks.md b/.github/ISSUE_TEMPLATE/3_product_release_checks.md index f7a7ea3e..999ed32d 100644 --- a/.github/ISSUE_TEMPLATE/3_product_release_checks.md +++ b/.github/ISSUE_TEMPLATE/3_product_release_checks.md @@ -26,10 +26,6 @@ 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 - -- [ ] **Threat Modeling Analysis** passed - # Test Results - [ ] **E2E Integration Test** passed From c5d31ba0a47be9a04c0e070fb367306f4abc7933 Mon Sep 17 00:00:00 2001 From: Theresa Hilger <84102125+ther3sa@users.noreply.github.com> Date: Thu, 8 Aug 2024 13:12:58 +0200 Subject: [PATCH 03/13] Add feature section to description --- .github/ISSUE_TEMPLATE/3_product_release_checks.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/3_product_release_checks.md b/.github/ISSUE_TEMPLATE/3_product_release_checks.md index 999ed32d..2f134618 100644 --- a/.github/ISSUE_TEMPLATE/3_product_release_checks.md +++ b/.github/ISSUE_TEMPLATE/3_product_release_checks.md @@ -26,6 +26,19 @@ 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 +# Features +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. + +List your features here: + +- [ ] + # Test Results - [ ] **E2E Integration Test** passed From 9e5d9990baca25a43e0c657cd38064a46dabe0dc Mon Sep 17 00:00:00 2001 From: Theresa Hilger <84102125+ther3sa@users.noreply.github.com> Date: Thu, 8 Aug 2024 13:19:09 +0200 Subject: [PATCH 04/13] Add summary section to description --- .github/ISSUE_TEMPLATE/3_product_release_checks.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/3_product_release_checks.md b/.github/ISSUE_TEMPLATE/3_product_release_checks.md index 2f134618..f6a390a5 100644 --- a/.github/ISSUE_TEMPLATE/3_product_release_checks.md +++ b/.github/ISSUE_TEMPLATE/3_product_release_checks.md @@ -39,6 +39,9 @@ List your features here: - [ ] +# Summary +Please provide a short summary about the new values/benefits of the new features here. + # Test Results - [ ] **E2E Integration Test** passed From 7b5d1086d6371f3d74fd22304dd874166e6d01db Mon Sep 17 00:00:00 2001 From: Theresa Hilger <84102125+ther3sa@users.noreply.github.com> Date: Thu, 8 Aug 2024 13:52:19 +0200 Subject: [PATCH 05/13] delete tasklist for feature and add note for feature --- .github/ISSUE_TEMPLATE/3_product_release_checks.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/3_product_release_checks.md b/.github/ISSUE_TEMPLATE/3_product_release_checks.md index f6a390a5..db6ca061 100644 --- a/.github/ISSUE_TEMPLATE/3_product_release_checks.md +++ b/.github/ISSUE_TEMPLATE/3_product_release_checks.md @@ -37,7 +37,10 @@ By documenting these features, you will contribute to a smoother and more effici List your features here: -- [ ] +- Link to feature + +> [!NOTE] +> Note: all features needs to be closed to get approval # Summary Please provide a short summary about the new values/benefits of the new features here. From dc37e30f1d311a5ff2406e0d90c640796511c118 Mon Sep 17 00:00:00 2001 From: Theresa Hilger <84102125+ther3sa@users.noreply.github.com> Date: Mon, 26 Aug 2024 12:20:07 +0200 Subject: [PATCH 06/13] Add empty line for features and summary for proper md format --- .github/ISSUE_TEMPLATE/3_product_release_checks.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/3_product_release_checks.md b/.github/ISSUE_TEMPLATE/3_product_release_checks.md index db6ca061..76aa2ae3 100644 --- a/.github/ISSUE_TEMPLATE/3_product_release_checks.md +++ b/.github/ISSUE_TEMPLATE/3_product_release_checks.md @@ -27,6 +27,7 @@ Make sure to open and fill in a separate **documentation issue** in your product > Note: most criteria for documentation and security are now covered in TRGs # Features + 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. @@ -43,6 +44,7 @@ List your features here: > Note: all features needs to be closed to get approval # Summary + Please provide a short summary about the new values/benefits of the new features here. # Test Results From b32574ffde29529d83bb526fa6850a9c130108bf Mon Sep 17 00:00:00 2001 From: Stephan Bauer Date: Tue, 27 Aug 2024 10:22:18 +0200 Subject: [PATCH 07/13] adapt QGate issue, add needed content --- .../3_product_release_checks.md | 85 +++++++++++++++---- 1 file changed, 69 insertions(+), 16 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/3_product_release_checks.md b/.github/ISSUE_TEMPLATE/3_product_release_checks.md index 76aa2ae3..1f94e999 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,12 +16,18 @@ 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* +**Version to be included in Eclipse Tractus-X release**: + + +- App version: *version placeholder* +- Helm Chart version: *version placeholder* **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) @@ -26,7 +35,50 @@ 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 -# Features +## Functionality + + +- [ ] Feature works as expected and described +- [ ] Backward compatibility maintained + +## Performance + + +- [ ] No performance degradation +- [ ] Memory usage is within acceptable limits +- [ ] No unnecessary computations or redundant operations + +## Testing + + +- [ ] Code is tested in different environments (GitHub Actions, local, int, etc.) +- [ ] Unit tests cover all new features +- [ ] Integration tests are updated +- [ ] E2E/Integration test passed +- [ ] Regressions tests passed +- [ ] User Journey approved + +## Documentation + + +- [ ] Documentation is updated to reflect changes +- [ ] README and other project documentation are clear and up-to-date + +## Deployment Readiness + + +- [ ] Release notes/Change logs are updated +- [ ] Migration scripts/documentation are included if necessary (Ensure that any database or infrastructure migrations are included). +- [ ] Known knowns + - topic 1 + - topic 2 + +## Feature summery + Please provide a list of all features that have been developed in the current phase. This list is essential for several reasons: @@ -36,22 +88,23 @@ Please provide a list of all features that have been developed in the current ph By documenting these features, you will contribute to a smoother and more efficient release process. -List your features here: - -- Link to feature - > [!NOTE] -> Note: all features needs to be closed to get approval +> Note: all features needs to be closed to get approval for release -# Summary +| 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 | -Please provide a short summary about the new values/benefits of the new features here. +## 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) From 021b6793ca4c6f4b998beeb88f2dfa0428b0782e Mon Sep 17 00:00:00 2001 From: Stephan Bauer Date: Wed, 28 Aug 2024 14:59:56 +0200 Subject: [PATCH 08/13] add contacts for release --- .github/ISSUE_TEMPLATE/3_product_release_checks.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/3_product_release_checks.md b/.github/ISSUE_TEMPLATE/3_product_release_checks.md index 1f94e999..7dbe8af3 100644 --- a/.github/ISSUE_TEMPLATE/3_product_release_checks.md +++ b/.github/ISSUE_TEMPLATE/3_product_release_checks.md @@ -16,6 +16,12 @@ 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. +**Responsible contacts**: + +- Committer: *GitHub handle* +- ExpertGroup: *GitHub handle* +- Technical contact: *GitHub handle* + **Version to be included in Eclipse Tractus-X release**: From 63f281162d52ba4ce496faf8f2968e585c6e0ce2 Mon Sep 17 00:00:00 2001 From: Theresa Hilger <84102125+ther3sa@users.noreply.github.com> Date: Wed, 4 Sep 2024 15:28:12 +0200 Subject: [PATCH 09/13] Update content based on discusions --- .../3_product_release_checks.md | 40 +++++++++---------- 1 file changed, 19 insertions(+), 21 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/3_product_release_checks.md b/.github/ISSUE_TEMPLATE/3_product_release_checks.md index 7dbe8af3..b003f4d6 100644 --- a/.github/ISSUE_TEMPLATE/3_product_release_checks.md +++ b/.github/ISSUE_TEMPLATE/3_product_release_checks.md @@ -45,41 +45,23 @@ Make sure to open and fill in a separate **documentation issue** in your product - [ ] Feature works as expected and described -- [ ] Backward compatibility maintained +- [ ] Backward compatibility maintained (depending Major/ Minor) ## Performance -- [ ] No performance degradation -- [ ] Memory usage is within acceptable limits -- [ ] No unnecessary computations or redundant operations +- [ ] Memory and CPU usage is within acceptable limits oriented with goldilocks ## Testing -- [ ] Code is tested in different environments (GitHub Actions, local, int, etc.) - [ ] Unit tests cover all new features - [ ] Integration tests are updated - [ ] E2E/Integration test passed - [ ] Regressions tests passed - [ ] User Journey approved -## Documentation - - -- [ ] Documentation is updated to reflect changes -- [ ] README and other project documentation are clear and up-to-date - -## Deployment Readiness - - -- [ ] Release notes/Change logs are updated -- [ ] Migration scripts/documentation are included if necessary (Ensure that any database or infrastructure migrations are included). -- [ ] Known knowns - - topic 1 - - topic 2 - -## Feature summery +## Feature summary + +- [ ] Documentation (related to new implemented features e.g. migration, api) is updated to reflect changes +- [ ] README and other project documentation are clear and up-to-date + +## Deployment Readiness + + +- [ ] Release notes/Change logs are updated +- [ ] Migration scripts/documentation are included if necessary (Ensure that any database or infrastructure migrations are included). +- [ ] Known knowns + - topic 1 + - topic 2 + + ## Summary From de7e97a5d79d59e45989f98a53616fa3fa7bbc06 Mon Sep 17 00:00:00 2001 From: Theresa Hilger <84102125+ther3sa@users.noreply.github.com> Date: Tue, 24 Sep 2024 12:34:37 +0200 Subject: [PATCH 10/13] Update .github/ISSUE_TEMPLATE/3_product_release_checks.md Co-authored-by: Evelyn Gurschler --- .github/ISSUE_TEMPLATE/3_product_release_checks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/3_product_release_checks.md b/.github/ISSUE_TEMPLATE/3_product_release_checks.md index b003f4d6..6397a829 100644 --- a/.github/ISSUE_TEMPLATE/3_product_release_checks.md +++ b/.github/ISSUE_TEMPLATE/3_product_release_checks.md @@ -91,7 +91,7 @@ By documenting these features, you will contribute to a smoother and more effici - [ ] Documentation (related to new implemented features e.g. migration, api) is updated to reflect changes - [ ] README and other project documentation are clear and up-to-date -## Deployment Readiness +## Release Documentation - [ ] Release notes/Change logs are updated From 9629e852430fd30820a32e65b5725a07742be593 Mon Sep 17 00:00:00 2001 From: Theresa Hilger <84102125+ther3sa@users.noreply.github.com> Date: Tue, 24 Sep 2024 12:34:53 +0200 Subject: [PATCH 11/13] Update .github/ISSUE_TEMPLATE/3_product_release_checks.md Co-authored-by: Evelyn Gurschler --- .github/ISSUE_TEMPLATE/3_product_release_checks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/3_product_release_checks.md b/.github/ISSUE_TEMPLATE/3_product_release_checks.md index 6397a829..ec6a46f4 100644 --- a/.github/ISSUE_TEMPLATE/3_product_release_checks.md +++ b/.github/ISSUE_TEMPLATE/3_product_release_checks.md @@ -94,7 +94,7 @@ By documenting these features, you will contribute to a smoother and more effici ## Release Documentation -- [ ] Release notes/Change logs are updated +- [ ] 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 From 4c7b4c8bcbaf26548012745bf1df2769d2a0903f Mon Sep 17 00:00:00 2001 From: Theresa Hilger <84102125+ther3sa@users.noreply.github.com> Date: Tue, 24 Sep 2024 12:59:40 +0200 Subject: [PATCH 12/13] Delete documentation section and user journey --- .github/ISSUE_TEMPLATE/3_product_release_checks.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/3_product_release_checks.md b/.github/ISSUE_TEMPLATE/3_product_release_checks.md index ec6a46f4..62c574bb 100644 --- a/.github/ISSUE_TEMPLATE/3_product_release_checks.md +++ b/.github/ISSUE_TEMPLATE/3_product_release_checks.md @@ -59,7 +59,6 @@ Make sure to open and fill in a separate **documentation issue** in your product - [ ] Integration tests are updated - [ ] E2E/Integration test passed - [ ] Regressions tests passed -- [ ] User Journey approved ## Feature summary - -- [ ] Documentation (related to new implemented features e.g. migration, api) is updated to reflect changes -- [ ] README and other project documentation are clear and up-to-date - ## Release Documentation @@ -100,7 +93,6 @@ By documenting these features, you will contribute to a smoother and more effici - topic 1 - topic 2 - ## Summary From 1522309ce9ae6205d469c137aa22bf833eb8077f Mon Sep 17 00:00:00 2001 From: Theresa Hilger <84102125+ther3sa@users.noreply.github.com> Date: Tue, 24 Sep 2024 13:04:10 +0200 Subject: [PATCH 13/13] Change responsible contacts: technical to contributor --- .github/ISSUE_TEMPLATE/3_product_release_checks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/3_product_release_checks.md b/.github/ISSUE_TEMPLATE/3_product_release_checks.md index 62c574bb..9108b306 100644 --- a/.github/ISSUE_TEMPLATE/3_product_release_checks.md +++ b/.github/ISSUE_TEMPLATE/3_product_release_checks.md @@ -20,7 +20,7 @@ Make sure to assign this issue to expert(s) for their approval, as soon as you h - Committer: *GitHub handle* - ExpertGroup: *GitHub handle* -- Technical contact: *GitHub handle* +- Contributor contact: *GitHub handle* **Version to be included in Eclipse Tractus-X release**: