QG checks (Release 24.08)

almadigabor commented 2 months ago

QG checks

Please open and fill in this issue in your product repository to document the compliance with our Tractus-X Release Guideline (TRGs)

Show compliance with TRGs by referencing to a tagged link in the respective repository where possible, example: TRG 1.01 (see github.com/eclipse-tractusx/example-repo/tree/1.0.0/README.md)

Close this issue once the compliance with the TRGs has been documented

Committer(s): Helm Chart Version: 2.1.21 App Version: 2.1.13

Release Management Reference Issue: https://github.com/eclipse-tractusx/sig-release/issues/744

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

[x] TRG 1.01 appropriate README.md
[x] TRG 1.02 appropriate install instructions either INSTALL.md or in README.md
[x] TRG 1.03 appropriate CHANGELOG.md
[x] TRG 1.04 editable static files
[x] TRG 1.05 architecture docs
[x] TRG 1.06 administrator guide
[x] TRG 1.07 user manual
[x] TRG 1.08 open api docs

TRG 2 Git

[x] TRG 2.01 default branch is named main
[x] TRG 2.03 repository structure
[x] TRG 2.04 leading product repository
[x] TRG 2.05 .tractusx metafile in a proper format
[x] TRG 2.06 Dependabot

TRG 3 Kubernetes

[x] TRG 3.02 persistent volume and persistent volume claim or database dependency (subchart) are in place when needed

TRG 4 Container

[x] TRG 4.01 semantic versioning and tagging
[x] TRG 4.02 base image is agreed
[x] TRG 4.03 image has USER command and Non Root Container
[x] TRG 4.05 released image must be placed in DockerHub, remove GHCR references
[x] TRG 4.06 separate notice file for DockerHub has all necessary information
[x] #203

TRG 5 Helm

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

TRG 6 Released Helm Chart

[x] TRG 6.01 Released Helm Chart

TRG 7 Open Source Governance

[x] TRG 7.01 Legal Documentation
[x] TRG 7.02 License and copyright header
[x] TRG 7.03 IP checks for project content
[x] TRG 7.04 IP checks for 3rd party content
[x] TRG 7.05 Legal information for distributions
[x] TRG 7.06 Legal information for end user content
[x] TRG 7.07 Legal notice for documentation (non-code)
[x] TRG 7.08 Legal notice for KIT documentation

TRG 8 Security

[x] TRG 8.01 Mitigate high and above findings in CodeQL
[x] TRG 8.02 Mitigate high and above findings in KICS
[x] TRG 8.04 Mitigate high and above findings in Trivy
[x] TRG 8.03 No secret findings by GitGuardian or TruffleHog

TRG 9 UX/UI Styleguide

[x] TRG 9.01 UI consistency/styleguide for UI

Hints

Information Sharing

RoKrish14 commented 2 months ago

Hi @almadigabor. I will carry out some of the TRG checks and will keep the checklist updated.

almadigabor commented 2 months ago

Hey @RoKrish14, excellent, thank you! I will then double check tonight or tomorrow morning.

ciprianherciu commented 2 months ago

@RoKrish14 for SD Factory and MSO the UX/UI style guide is not needed

almadigabor commented 2 months ago

Checks are done from my side and approve the QG with the following versions:

Helm Chart Version: 2.1.21 App Version: 2.1.13

eclipse-tractusx / sd-factory