Merge branch 'main' into dependabot/go_modules/release-automation/git…

…hub.com/fatih/color-1.17.0
eclipse-tractusx · Jan 17, 2025 · 2b57f36 · 2b57f36
2 parents 2a8d2cf + 52adb7f
commit 2b57f36
Show file tree

Hide file tree

Showing 3 changed files with 194 additions and 23 deletions.
diff --git a/.github/ISSUE_TEMPLATE/1_feature_template.md b/.github/ISSUE_TEMPLATE/1_feature_template.md
@@ -3,22 +3,103 @@ name: Propose a Feature
 about: propose a new functionality
 ---
 
-## Description
+# Overview
 <!-- 
 A clear and concise description of what the desired feature will look like. 
 What is the purpose, what´s the expected result. 
 Please describe.
+
+Please see here an [example feature](https://github.com/eclipse-tractusx/sig-release/issues/882)
 -->
 
-## Impact
+## Explain the topic in 2 sentences
+<!-- provide a short overview -->
+
+## What's the benefit?
+<!--  do we increase security/efficiency/ reduce complexity? -->
+
+## What are the Risks/Dependencies ?
+<!--  breaking change? Do you have an interface partner you need to align with? does it require review from the architecture team? -->
+
+## Detailed explanation
+<!-- explain the idea in detail , what is the current situation , what needs to be changed  -->
+
+### Current implementation
+
+### Proposed improvements
+
+## Feature Team
+
+### Contributor
+<!-- names are already needed for open planning -->
+- Contributor 1
+- Contributor 2
+
+### Committer
+<!-- names are already needed for open planning -->
+- Committer 1
+- Committer 2
+<!--  can be delivered after Planning Phase 1 -->
+
+## User Stories
+<!--  define the sub-issues that lead to the full development of this feature -->
+- Issue 1, linked to specific repository
+- Issue 2, linked to another specific repository
+
+## Acceptance Criteria
 <!--
-If possible, please provide insight in what and how many components and teams might be affected or give a hint, if the feature implementation might result in breaking changes.
-If there are dependencies to other features please name it.
+Add all Acceptance Criteria. These criteria are important for the definition of done
 -->
+- [ ] Criteria 1
+- [ ] Criteria 2
+- [ ] Criteria 3
+
+## Test Cases
+<!-- add testcases - proposed structure (Description/Steps/Expected Result) -->
+
+### Test Case 1
+<!--  description -->
+#### Steps
+
+1. Do something
+2. Click something
+3. Add something
 
-## Additional information 
+#### Expected Result
+
+1. Expectation
+2. Expectation
+3. Expectation
+
+## Architectural Relevance
+<!--
+The Architecture Management Committee monitors and controls the overarching architecture. It is essential that all applications and documentations follows a baseline set of standards and guidelines. These small checks ensure that the proposed change does not compromise our general principles.
+-->
+The following items are ensured (answer: yes) after this issue is implemented.
 
-- [ ] I'm willing to contribute to this feature
+In the context of the standards [126](https://catenax-ev.github.io/docs/standards/CX-0126-IndustryCorePartType) and [127](https://catenax-ev.github.io/docs/standards/CX-0127-IndustryCorePartInstance), typically only one is applicable, depending on the specific use case. Please cross out one of the two standards that does not apply.
 
+- [ ] This feature aligns with our current architectural guidelines
+  - **Data Sovereignty:** All data sharing activities across company boundaries follow the [Catena-X Regulatory Framework](https://catenax-ev.github.io/docs/next/regulatory-framework/governance-framework), in particular the [Data Exchange Governance](https://catenax-ev.github.io/docs/next/regulatory-framework/20000ft/data-exchange-governance), and the [Dataspace Protocol](https://docs.internationaldataspaces.org/dataspace-protocol/overview/readme) via a compliant Connector (like the [tractusx-edc](https://github.com/eclipse-tractusx/tractusx-edc) or similar, see [Connector KIT](https://eclipse-tractusx.github.io/docs-kits/next/category/connector-kit))
+    - [ ] [CX-0010 Business Partner Number](https://catenax-ev.github.io/docs/next/standards/CX-0010-BusinessPartnerNumber)
+    - [ ] [CX-0013 Identity of Member Companies](https://catenax-ev.github.io/docs/next/standards/CX-0013-IdentityOfMemberCompanies)
+    - [ ] [CX-0018 Data Space Connectivity (EDC)](https://catenax-ev.github.io/docs/next/standards/CX-0018-DataspaceConnectivity)
+    - [ ] [CX-0049 DID Document Schema](https://catenax-ev.github.io/docs/next/standards/CX-0049-DIDDocumentSchema)
+    - [ ] [CX-0050 Framework Agreement Credential](https://catenax-ev.github.io/docs/next/standards/CX-0050-FrameworkAgreementCredential)
+    - [ ] [CX-0149 Verified Company Identity](https://catenax-ev.github.io/docs/next/standards/CX-0149-Dataspaceidentityandidentification)
+  - **Interoperability:** Digital Twins are used (compliant to the [Digital Twin KIT](https://eclipse-tractusx.github.io/docs-kits/next/category/digital-twin-kit) and the [Industry Core KIT](https://eclipse-tractusx.github.io/docs-kits/next/category/industry-core-kit))
+    - [ ] [CX-0001 EDC Discovery API](https://catenax-ev.github.io/docs/next/standards/CX-0001-EDCDiscoveryAPI)
+    - [ ] [CX-0002 Digital Twins in Catena-X](https://catenax-ev.github.io/docs/next/standards/CX-0002-DigitalTwinsInCatenaX)
+    - [ ] [CX-0018 Data Space Connectivity (EDC)](https://catenax-ev.github.io/docs/next/standards/CX-0018-DataspaceConnectivity)
+    - [ ] [CX-0126 Industry Core: Part Type 2.0.0](https://catenax-ev.github.io/docs/standards/CX-0126-IndustryCorePartType)
+    - [ ] [CX-0127 Industry Core: Part Instance 2.0.0](https://catenax-ev.github.io/docs/standards/CX-0127-IndustryCorePartInstance)
+  - **Data Format:**
+    - [ ] The data model is based on a [published Semantic Model](https://github.com/eclipse-tractusx/sldt-semantic-models)
+- [ ] The impact on the overall system architecture has been assessed. The Feature does not require changes to the architecture or any existing standard? Please have a look here on the [overarching architecture](https://eclipse-tractusx.github.io/docs/tutorials/e2e/inform/architecture)
+- [ ] Potential risks or conflicts with existing architecture has been assessed
 
+**Justification:** _(Fill this out, if at least one of the checkboxes above cannot be ticked. Contact the Architecture Management Committee to get an approval for the justification)_
 
+## Additional information
+<!-- this is only needed, if contributors and committers are not known during feature creation -->
+- [ ] I am aware that my request may not be developed if no developer can be found for it. I'll try to contribute a developer (bring your own developer)
diff --git a/.github/ISSUE_TEMPLATE/3_product_release_checks.md b/.github/ISSUE_TEMPLATE/3_product_release_checks.md
@@ -4,42 +4,103 @@ 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).
+<!-- 
+Thanks for your contribution! Please fill out this template as good as possible. 
+Important: Contributing Guidelines can be found here: https://eclipse-tractusx.github.io/docs/oss/how-to-contribute
+Checkout the repository README for process description. 
+-->
 
 ## Release Info
 
 Please provide information on what you want to be included in the Eclipse Tractus-X release.
 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**:
+<!-- For this new release -->
+- 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**:
+<!-- Responsibility: Committer -->
 
-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
+<!-- Responsibility: Committer, ExpertGroup, Technical Committee for Standardization -->
 
+- [ ] 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)
+
 > [!NOTE]
 > Note: most criteria for documentation and security are now covered in TRGs
 
-# Security Checks
+## Functionality
+<!-- Responsibility: Committer, Testmanagement -->
+
+- [ ] Feature works as expected and described
+- [ ] Backward compatibility maintained (depending Major/ Minor) 
+
+## Performance
+<!-- Responsibility: Testmanagement -->
+
+- [ ] Memory and CPU usage is within acceptable limits oriented with goldilocks 
+
+## Testing
+<!-- Responsibility: Committer, Testmanagement -->
+
+- [ ] Unit tests cover all new features
+- [ ] Integration tests are updated
+- [ ] E2E/Integration test passed
+- [ ] Regressions tests passed
+
+## Feature summary
+<!-- 
+Responsibility:
+- Committer -> adding the features
+- Testmanagement -> approval for teststatus
+-->
+
+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
+<!-- Responsibility: Committer, Testmanagement, Releasemanagement -->
+
+- [ ] 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
+<!-- Responsibility: Committer -->
 
-# 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)
+- [Eclipse Tractus-X API Hub](https://eclipse-tractusx.github.io/api-hub)
diff --git a/.github/ISSUE_TEMPLATE/5_KIT_template.md b/.github/ISSUE_TEMPLATE/5_KIT_template.md
@@ -0,0 +1,29 @@
+---
+name: Propose KIT
+labels: kit
+---
+
+# Overview
+
+## Description
+<!-- Please provide a short description -->
+
+## Major Changes / Major Adjustments
+<!-- Please specify the nature and impact of the changes -->
+- Impact 1
+
+## KIT Team
+
+### Contributor
+<!-- names are already needed for open planning. Please also assign the contributor to this issue to ensure better clarity and accountability. -->
+- Contributor 1
+- Contributor 2
+
+### Committer
+<!-- names are already needed for open planning. Please also assign the committer to this issue to ensure better clarity and accountability -->
+- Committer 1
+- Committer 2
+
+## Helpful links
+
+- [Catena-X standard library](https://catenax-ev.github.io/docs/next/standards/overview)