QG 4 checks (Release 23.12)

[carslen]

QG checks

Please keep this issue open until QG is concluded and will be managed by the Issue Creator!
We will inform you about finding and proposals in separated issues, this issue here is for the Overview of the Checks!

Please keep this issue open until QG is concluded!

Product Owner: @jjeroch
Dev SPOC:
Helm Chart Version: 1.5.2
App Version: 1.5.2
Release Managemnet Reference Issue: eclipse-tractusx/sig-release#106

Check of Tractus-X Release Guidelines

• Currently implemented automatic checks can be found under your product on our Release Guidelines Checks Board
• This QG Check is depending on the mandatory information from our current Release Guidelines

TRG 1 Documentation

• TRG 1.01 appropriate README.md
• TRG 1.02 appropriate install instructions either INSTALL.md or in README.md
• TRG 1.03 appropriate CHANGELOG.md

TRG 2 Git

• TRG 2.01 default branch is named main
• TRG 2.03 repository structure
• TRG 2.04 leading product repository
• TRG 2.05 .tractusx metafile in a proper format

TRG 3 Kubernetes

• TRG 3.02 persistent volume and persistent volume claim is used when needed

TRG 4 Container

• TRG 4.01 multiple container tags #83
• TRG 4.02 base image is agreed
• TRG 4.03 image has USER command and Non Root Container
• TRG 4.05 released image must be placed in DockerHub, remove GHCR references
• TRG 4.06 separate notice file for DockerHub has all necessary information

TRG 5 Helm

• TRG 5.01 Helm chart must be released
• TRG 5.02 Helm chart location in /charts directory and correct structure
• TRG 5.04 CPU / MEM resource requests and limits and are properly set
• TRG 5.06 Application must be configurable through the Helm chart
• TRG 5.07 Dependencies are present and properly configured in the Chart.yaml
• TRG 5.08 Product has a single deployable helm chart that contains all components
• TRG 5.09 Helm Test running properly
• TRG 5.10 Products need to support 3 versions at a time
• TRG 5.11 Upgradeability

TRG 6 Released Helm Chart

• TRG 6.01 Released Helm Chart

TRG 7 Open Source Governance

• TRG 7.01 Legal Documentation
• TRG 7.02 License and copyright header
• TRG 7.03 IP checks for project content
• TRG 7.04 IP checks for 3rd party content
• TRG 7.05 Legal information for distributions #84
• TRG 7.06 Legal information for end user content #85
• TRG 7.07 Legal notice for documentation

Hints

Information Sharing

Skipping TRG 5 + 6 as Helm Charts are part of repo portal-cd

[carslen]

Shall be v1.5.3 checked, which has been released last week, instead of the 1.5.2 mentioned in eclipse-tractusx/sig-release#106, @evegufy ?

[carslen]

Checks finished for portal-frontend-registration, based on 1.5.3. I've opened following issues:

• TRG 4.01 multiple container tags #83
• TRG 7.05 Legal information for distributions #84
• TRG 7.06 Legal information for end user content #85

Please take care, @evegufy