QG checks (Release 23.12)

[FaGru3n]

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!

Eclipse Tractus-X repository: https://github.com/eclipse-tractusx/sldt-bpn-discovery
Product Owner: @thomas-henn
Dev SPOC: @tunacicek @agg3fe @bs-jokri @bs-sili
Helm Chart Version: discoveryfinder-0.1.12
App Version: 0.2.5

Release Managemnet Reference Issue: updates eclipse-tractusx/sig-release#122

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

back on top

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

back on top

TRG 3 Kubernetes

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

back on top

TRG 4 Container

• TRG 4.01 semantic versioning and tagging
• 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

back on top

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 Add helm upgrade workflow #38
• TRG 5.10 Products need to support 3 versions at a time chore: make helm test possible on worklow dispatch #62
• TRG 5.11 Upgradeability chore: make helm test possible on worklow dispatch #62

back on top

TRG 6 Released Helm Chart

• TRG 6.01 Released Helm Chart

back on top

TRG 7 Open Source Governance

• TRG 7.01 Legal Documentation
• TRG 7.02 License and copyright header Licence Header is outdated #58
• TRG 7.03 IP checks for project content
• TRG 7.04 IP checks for 3rd party content DEPENDENCIES out of Date #64
• TRG 7.05 Legal information for distributions
• TRG 7.06 Legal information for end user content
• TRG 7.07 Legal notice for documentation #60

back on top

Hints

Information Sharing

[FaGru3n]

Hi all,

could you please give the following information, so basically what is agreed with the release-management and it is also mentioned in
eclipse-tractusx/sig-release#122

Eclipse Tractus-X repository: https://github.com/eclipse-tractusx/sldt-bpn-discovery
Helm Chart Version: ?
App Version: ?

[bs-sili]

Hi @FaGru3n,

Helm Chart Version: discoveryfinder-0.1.12
App Version: 0.2.5

[FaGru3n]

Hi @FaGru3n,

Helm Chart Version: discoveryfinder-0.1.12 App Version: 0.2.5

Hi just a question,

you provided the following information
Helm Chart Version: discoveryfinder-0.1.12
App Version: 0.2.5

but within the Chart.yml it is referenced App-Version 0.2.6 in chart tag bpndiscovery-0.1.12
so i guess a typo
https://github.com/eclipse-tractusx/sldt-bpn-discovery/blob/bpndiscovery-0.1.12/charts/bpndiscovery/Chart.yaml#L27-L28

[FaGru3n]

To all really thanks for your help guess we are done here...

probs to you! 🏅