Skip to content
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.

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

docs: update product release issue template #813

Merged
merged 14 commits into from
Oct 8, 2024
Merged
99 changes: 83 additions & 16 deletions .github/ISSUE_TEMPLATE/3_product_release_checks.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,44 +4,111 @@ 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*
- Technical contact: *GitHub handle*
ther3sa marked this conversation as resolved.
Show resolved Hide resolved

**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
- [ ] User Journey approved
ther3sa marked this conversation as resolved.
Show resolved Hide resolved

## 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 |

## Documentation
ther3sa marked this conversation as resolved.
Show resolved Hide resolved
<!-- Responsibility: Committer -->

- [ ] 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
ther3sa marked this conversation as resolved.
Show resolved Hide resolved
<!-- Responsibility: Committer, Testmanagement, Releasemanagement -->

- [ ] Release notes/Change logs are updated
ther3sa marked this conversation as resolved.
Show resolved Hide resolved
- [ ] 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)
Loading