feat(release-checks): introduce discrimination of quality guidelines by repo category (#1530)

tom-rm-meyer-ISST · web-flow · commit 54620d18ac67 · 2025-09-29T17:24:21.000+02:00
* feat(release-checks): introduce discrimination of quality guidelines by repo category

* chore(test_runner): fix log messages, remove outcommented code and fix typos
diff --git a/release-automation/cmd/run_trg_checks.go b/release-automation/cmd/run_trg_checks.go
@@ -49,7 +49,18 @@ var checkLocalCmd = &cobra.Command{
 			basedir = "./"
 		}
 
-		var releaseGuidelines = []tractusx.QualityGuideline{
+		metadata, err := tractusx.MetadataFromLocalFile(basedir)
+		if err != nil {
+			fmt.Println("Error occurred! Metadata file (.tractusx) missing at root directory of repo. Please check out TRG 2.05: https://eclipse-tractusx.github.io/docs/release/trg-2/trg-2-05")
+			os.Exit(1)
+		}
+
+		if metadata.RepoCategory == tractusx.RepoCategoryUnknown {
+			fmt.Println("Error occurred! Metadata file (.tractusx) contains no or unknown repository category. Please check out TRG 2.05: https://eclipse-tractusx.github.io/docs/release/trg-2/trg-2-05")
+			os.Exit(1)
+		}
+
+		allReleaseGuidelines := []tractusx.QualityGuideline{
 			docs.NewReadmeExists(basedir),
 			docs.NewInstallExists(basedir),
 			docs.NewChangelogExists(basedir),
@@ -66,8 +77,10 @@ var checkLocalCmd = &cobra.Command{
 			open_source.NewNoticeForNonCodeExists(basedir),
 		}
 
-		runner := testrunner.NewTestRunner(releaseGuidelines)
-		err := runner.Run()
+		//applicableGuidelines := getApplicableGuidelines(allReleaseGuidelines, metadata.RepoCategory)
+
+		runner := testrunner.NewTestRunner(allReleaseGuidelines, *metadata)
+		err = runner.Run()
 
 		if err != nil {
 			fmt.Println("Error occurred! Check command output for details on failed checks")
@@ -78,6 +91,16 @@ var checkLocalCmd = &cobra.Command{
 	},
 }
 
+func getApplicableGuidelines(allGuidelines []tractusx.QualityGuideline, category tractusx.RepoCategory) []tractusx.QualityGuideline {
+	var applicable []tractusx.QualityGuideline
+	for _, guideline := range allGuidelines {
+		if guideline.IsApplicableToCategory(category) {
+			applicable = append(applicable, guideline)
+		}
+	}
+	return applicable
+}
+
 func init() {
 	rootCmd.AddCommand(checkLocalCmd)
 }
diff --git a/release-automation/internal/container/allowed_base_image_check.go b/release-automation/internal/container/allowed_base_image_check.go
@@ -1,5 +1,6 @@
 /*******************************************************************************
  * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ * Copyright (c) 2025 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST)
  *
  * See the NOTICE file(s) distributed with this work for additional
  * information regarding copyright ownership.
@@ -127,3 +128,7 @@ func containsString(slice []string, element string) bool {
 	}
 	return false
 }
+
+func (a *AllowedBaseImage) IsApplicableToCategory(category tractusx.RepoCategory) bool {
+	return category == tractusx.RepoCategoryProduct
+}
diff --git a/release-automation/internal/container/dockerfile.go b/release-automation/internal/container/dockerfile.go
@@ -1,5 +1,6 @@
 /*******************************************************************************
  * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ * Copyright (c) 2025 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST)
  *
  * See the NOTICE file(s) distributed with this work for additional
  * information regarding copyright ownership.
@@ -28,6 +29,7 @@ import (
 	pathUtil "path"
 	"path/filepath"
 	"strings"
+	"tractusx-release-automation/internal/tractusx"
 )
 
 // dockerfile is a simple utility to create or read dockerfiles.
@@ -160,3 +162,7 @@ func readLines(file *os.File) []string {
 	}
 	return lines
 }
+
+func (a *dockerfile) IsApplicableToCategory(category tractusx.RepoCategory) bool {
+	return category == tractusx.RepoCategoryProduct
+}
diff --git a/release-automation/internal/container/non_root_container_check.go b/release-automation/internal/container/non_root_container_check.go
@@ -1,5 +1,6 @@
 /*******************************************************************************
  * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ * Copyright (c) 2025 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST)
  *
  * See the NOTICE file(s) distributed with this work for additional
  * information regarding copyright ownership.
@@ -113,3 +114,7 @@ func isRootUser(user string) bool {
 func isRootGroup(group string) bool {
 	return group == "root" || group == "0"
 }
+
+func (a *NonRootContainer) IsApplicableToCategory(category tractusx.RepoCategory) bool {
+	return category == tractusx.RepoCategoryProduct
+}
diff --git a/release-automation/internal/dashboard/tractusx.go b/release-automation/internal/dashboard/tractusx.go
@@ -190,7 +190,7 @@ func getProductsFromMetadata(metadataForRepo map[string]repoInfo) []Product {
 			log.Printf("Repo %s is leading, addign name (%s) + repo URL (%s) to product", url, info.metadata.ProductName, info.metadata.LeadingRepository)
 			p.Name = info.metadata.ProductName
 			p.LeadingRepo = info.metadata.LeadingRepository
-			p.RepoCategory = info.metadata.RepoCategory
+			p.RepoCategory = info.metadata.RepoCategory.String()
 		}
 	}
 
diff --git a/release-automation/internal/docs/admin_guide_exists.go b/release-automation/internal/docs/admin_guide_exists.go
@@ -60,3 +60,7 @@ func (a *AdminGuideExists) Test() *tractusx.QualityResult {
 func (a *AdminGuideExists) IsOptional() bool {
 	return true
 }
+
+func (a *AdminGuideExists) IsApplicableToCategory(category tractusx.RepoCategory) bool {
+	return category == tractusx.RepoCategoryProduct
+}
diff --git a/release-automation/internal/docs/architecture_documentation_exists.go b/release-automation/internal/docs/architecture_documentation_exists.go
@@ -92,3 +92,7 @@ func getArchitectureDocEntryPaths(dir string) []string {
 
 	return append(allowedArchitectureDocsGlob, file.ArchitectureDocEntryPath)
 }
+
+func (a *ArchitectureDocumentationExists) IsApplicableToCategory(category tractusx.RepoCategory) bool {
+	return category == tractusx.RepoCategoryProduct
+}
diff --git a/release-automation/internal/docs/changelog_exists.go b/release-automation/internal/docs/changelog_exists.go
@@ -1,5 +1,6 @@
 /*******************************************************************************
  * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ * Copyright (c) 2025 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST)
  *
  * See the NOTICE file(s) distributed with this work for additional
  * information regarding copyright ownership.
@@ -61,3 +62,7 @@ func (c ChangeLogExists) Test() *tractusx.QualityResult {
 	}
 	return &tractusx.QualityResult{Passed: true}
 }
+
+func (a *ChangeLogExists) IsApplicableToCategory(category tractusx.RepoCategory) bool {
+	return category == tractusx.RepoCategoryProduct || category == tractusx.RepoCategorySupport || category == tractusx.RepoCategorySpecial
+}
diff --git a/release-automation/internal/docs/install_exists.go b/release-automation/internal/docs/install_exists.go
@@ -1,5 +1,6 @@
 /*******************************************************************************
  * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ * Copyright (c) 2025 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST)
  *
  * See the NOTICE file(s) distributed with this work for additional
  * information regarding copyright ownership.
@@ -64,3 +65,7 @@ func (i *InstallExists) Test() *tractusx.QualityResult {
 func (i *InstallExists) IsOptional() bool {
 	return true
 }
+
+func (a *InstallExists) IsApplicableToCategory(category tractusx.RepoCategory) bool {
+	return category == tractusx.RepoCategoryProduct
+}
diff --git a/release-automation/internal/docs/readme_exists.go b/release-automation/internal/docs/readme_exists.go
@@ -1,5 +1,6 @@
 /*******************************************************************************
  * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ * Copyright (c) 2025 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST)
  *
  * See the NOTICE file(s) distributed with this work for additional
  * information regarding copyright ownership.
@@ -61,3 +62,7 @@ func (r *ReadmeExists) Test() *tractusx.QualityResult {
 	}
 	return &tractusx.QualityResult{Passed: true}
 }
+
+func (a *ReadmeExists) IsApplicableToCategory(category tractusx.RepoCategory) bool {
+	return category == tractusx.RepoCategoryProduct || category == tractusx.RepoCategorySupport || category == tractusx.RepoCategorySpecial
+}
diff --git a/release-automation/internal/helm/helm_workflow_check.go b/release-automation/internal/helm/helm_workflow_check.go
@@ -1,5 +1,6 @@
 /*******************************************************************************
  * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ * Copyright (c) 2025 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST)
  *
  * See the NOTICE file(s) distributed with this work for additional
  * information regarding copyright ownership.
@@ -21,13 +22,14 @@ package helm
 
 import (
 	"fmt"
-	"gopkg.in/yaml.v3"
 	"log"
 	"os"
 	"path"
 	"regexp"
 	"strings"
 	"tractusx-release-automation/internal/tractusx"
+
+	"gopkg.in/yaml.v3"
 )
 
 type HelmWorkflowCheck struct {
@@ -150,3 +152,7 @@ func loadGitHubWorkflowFromFile(filePath string) (GitHubWorkflow, error) {
 
 	return w, nil
 }
+
+func (a *HelmWorkflowCheck) IsApplicableToCategory(category tractusx.RepoCategory) bool {
+	return category == tractusx.RepoCategoryProduct
+}
diff --git a/release-automation/internal/helm/helmchart_structure_exists.go b/release-automation/internal/helm/helmchart_structure_exists.go
@@ -1,5 +1,6 @@
 /*******************************************************************************
  * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ * Copyright (c) 2025 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST)
  *
  * See the NOTICE file(s) distributed with this work for additional
  * information regarding copyright ownership.
@@ -139,3 +140,7 @@ func validateChart(chartYamlFile string) error {
 	}
 	return nil
 }
+
+func (a *HelmStructureExists) IsApplicableToCategory(category tractusx.RepoCategory) bool {
+	return category == tractusx.RepoCategoryProduct
+}
diff --git a/release-automation/internal/helm/resource_mgmt_check.go b/release-automation/internal/helm/resource_mgmt_check.go
@@ -1,5 +1,6 @@
 /*******************************************************************************
  * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ * Copyright (c) 2025 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST)
  *
  * See the NOTICE file(s) distributed with this work for additional
  * information regarding copyright ownership.
@@ -22,17 +23,18 @@ package helm
 import (
 	"errors"
 	"fmt"
+	"os"
+	"path"
+	"strings"
+	"tractusx-release-automation/internal/tractusx"
+
 	"golang.org/x/text/cases"
 	"golang.org/x/text/language"
 	"helm.sh/helm/v3/pkg/chart/loader"
 	"helm.sh/helm/v3/pkg/engine"
 	"k8s.io/api/apps/v1"
 	core "k8s.io/api/core/v1"
 	"k8s.io/client-go/kubernetes/scheme"
-	"os"
-	"path"
-	"strings"
-	"tractusx-release-automation/internal/tractusx"
 )
 
 type ResourceMgmt struct {
@@ -191,3 +193,7 @@ func firstCharUppercase(err error) string {
 
 	return result
 }
+
+func (a *ResourceMgmt) IsApplicableToCategory(category tractusx.RepoCategory) bool {
+	return category == tractusx.RepoCategoryProduct
+}
diff --git a/release-automation/internal/open_source/legal_notice_non_code_exists.go b/release-automation/internal/open_source/legal_notice_non_code_exists.go
@@ -43,6 +43,8 @@ var excludedFileGlobs = []string{
 	"NOTICE.md",
 	"**/NOTICE.md",
 	"**/DOCKER_NOTICE.md",
+	"node_modules/",
+	"**/node_modules/",
 }
 
 type NoticeForNonCodeExists struct {
@@ -245,3 +247,7 @@ func getExcludedGlobs(dir string) []string {
 
 	return append(excludedFileGlobs, file.LegalNoticesNonCode...)
 }
+
+func (a *NoticeForNonCodeExists) IsApplicableToCategory(category tractusx.RepoCategory) bool {
+	return category == tractusx.RepoCategoryProduct || category == tractusx.RepoCategorySupport || category == tractusx.RepoCategorySpecial
+}
diff --git a/release-automation/internal/repo/default_branch.go b/release-automation/internal/repo/default_branch.go
@@ -1,5 +1,6 @@
 /*******************************************************************************
  * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ * Copyright (c) 2025 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST)
  *
  * See the NOTICE file(s) distributed with this work for additional
  * information regarding copyright ownership.
@@ -23,8 +24,9 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/google/go-github/v53/github"
 	"tractusx-release-automation/internal/tractusx"
+
+	"github.com/google/go-github/v53/github"
 )
 
 type defaultBranch struct {
@@ -86,3 +88,7 @@ func getRepoInfo(repo *RepoInfo) *github.Repository {
 
 	return repoInfo
 }
+
+func (a *defaultBranch) IsApplicableToCategory(category tractusx.RepoCategory) bool {
+	return category == tractusx.RepoCategoryProduct || category == tractusx.RepoCategorySupport || category == tractusx.RepoCategorySpecial
+}
diff --git a/release-automation/internal/repo/leading_repo_defined.go b/release-automation/internal/repo/leading_repo_defined.go
@@ -1,5 +1,6 @@
 /*******************************************************************************
  * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ * Copyright (c) 2025 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST)
  *
  * See the NOTICE file(s) distributed with this work for additional
  * information regarding copyright ownership.
@@ -64,3 +65,7 @@ func (l *LeadingRepositoryDefined) Test() *tractusx.QualityResult {
 
 	return &tractusx.QualityResult{Passed: true}
 }
+
+func (a *LeadingRepositoryDefined) IsApplicableToCategory(category tractusx.RepoCategory) bool {
+	return category == tractusx.RepoCategoryProduct || category == tractusx.RepoCategorySupport || category == tractusx.RepoCategorySpecial
+}
diff --git a/release-automation/internal/repo/repo_structure_exists.go b/release-automation/internal/repo/repo_structure_exists.go
@@ -1,5 +1,6 @@
 /*******************************************************************************
  * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ * Copyright (c) 2025 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST)
  *
  * See the NOTICE file(s) distributed with this work for additional
  * information regarding copyright ownership.
@@ -74,13 +75,20 @@ func (c RepoStructureExists) Test() *tractusx.QualityResult {
 
 	mandatoryForLeadingRepo := []string{
 		path.Join(c.baseDir, "docs"),
+	}
+
+	mandatoryForLeadingProductRepo := []string{
 		path.Join(c.baseDir, "charts"),
 	}
 
 	printer := &tractusx.StdoutPrinter{}
 
 	if isLeadingRepo(c.baseDir) {
 		listOfMandatoryFilesToBeChecked = append(listOfMandatoryFilesToBeChecked, mandatoryForLeadingRepo...)
+
+		if isProductRepo(c.baseDir) {
+			listOfMandatoryFilesToBeChecked = append(listOfMandatoryFilesToBeChecked, mandatoryForLeadingProductRepo...)
+		}
 	}
 
 	missingMandatoryFiles := filesystem.CheckMissingFiles(listOfMandatoryFilesToBeChecked)
@@ -99,10 +107,19 @@ func (c RepoStructureExists) Test() *tractusx.QualityResult {
 	if len(missingMandatoryFiles) > 0 {
 		cleanMissingFiles := []string{}
 		for _, missingFile := range missingMandatoryFiles {
-			cleanMissingFiles = append(cleanMissingFiles, strings.Split(missingFile, c.baseDir)[1][1:])
+			// if a mandatory folder is missing, the path does not contain the base dir and thus mustn't be removed
+			if strings.HasPrefix(missingFile, c.baseDir) {
+				cleanMissingFiles = append(cleanMissingFiles, strings.Split(missingFile, c.baseDir)[1][1:])
+			} else {
+				cleanMissingFiles = append(cleanMissingFiles, missingFile)
+			}
 		}
 		return &tractusx.QualityResult{ErrorDescription: "The check detected following mandatory files missing: " + strings.Join(cleanMissingFiles, ", ")}
 	}
 
 	return &tractusx.QualityResult{Passed: true}
 }
+
+func (a *RepoStructureExists) IsApplicableToCategory(category tractusx.RepoCategory) bool {
+	return category == tractusx.RepoCategoryProduct || category == tractusx.RepoCategorySupport || category == tractusx.RepoCategorySpecial
+}
diff --git a/release-automation/internal/repo/repoinfo.go b/release-automation/internal/repo/repoinfo.go
diff --git a/release-automation/internal/test_runner/test_runner.go b/release-automation/internal/test_runner/test_runner.go
diff --git a/release-automation/internal/test_runner/test_runner_mock.go b/release-automation/internal/test_runner/test_runner_mock.go
diff --git a/release-automation/internal/test_runner/test_runner_test.go b/release-automation/internal/test_runner/test_runner_test.go
diff --git a/release-automation/internal/tractusx/metadata.go b/release-automation/internal/tractusx/metadata.go
diff --git a/release-automation/internal/tractusx/metadata_test.go b/release-automation/internal/tractusx/metadata_test.go
diff --git a/release-automation/internal/tractusx/types.go b/release-automation/internal/tractusx/types.go

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`/*******************************************************************************`
`2`	`2`	`* Copyright (c) 2023 Contributors to the Eclipse Foundation`
	`3`	`+ * Copyright (c) 2025 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST)`
`3`	`4`	`*`
`4`	`5`	`* See the NOTICE file(s) distributed with this work for additional`
`5`	`6`	`* information regarding copyright ownership.`
`@@ -127,3 +128,7 @@ func containsString(slice []string, element string) bool {`
`127`	`128`	`}`
`128`	`129`	`return false`
`129`	`130`	`}`
	`131`	`+`
	`132`	`+func (a *AllowedBaseImage) IsApplicableToCategory(category tractusx.RepoCategory) bool {`
	`133`	`+ return category == tractusx.RepoCategoryProduct`
	`134`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -190,7 +190,7 @@ func getProductsFromMetadata(metadataForRepo map[string]repoInfo) []Product {`
`190`	`190`	`log.Printf("Repo %s is leading, addign name (%s) + repo URL (%s) to product", url, info.metadata.ProductName, info.metadata.LeadingRepository)`
`191`	`191`	`p.Name = info.metadata.ProductName`
`192`	`192`	`p.LeadingRepo = info.metadata.LeadingRepository`
`193`		`- p.RepoCategory = info.metadata.RepoCategory`
	`193`	`+ p.RepoCategory = info.metadata.RepoCategory.String()`
`194`	`194`	`}`
`195`	`195`	`}`
`196`	`196`
Original file line number	Diff line number	Diff line change
`@@ -60,3 +60,7 @@ func (a AdminGuideExists) Test() tractusx.QualityResult {`
`60`	`60`	`func (a *AdminGuideExists) IsOptional() bool {`
`61`	`61`	`return true`
`62`	`62`	`}`
	`63`	`+`
	`64`	`+func (a *AdminGuideExists) IsApplicableToCategory(category tractusx.RepoCategory) bool {`
	`65`	`+ return category == tractusx.RepoCategoryProduct`
	`66`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -92,3 +92,7 @@ func getArchitectureDocEntryPaths(dir string) []string {`
`92`	`92`
`93`	`93`	`return append(allowedArchitectureDocsGlob, file.ArchitectureDocEntryPath)`
`94`	`94`	`}`
	`95`	`+`
	`96`	`+func (a *ArchitectureDocumentationExists) IsApplicableToCategory(category tractusx.RepoCategory) bool {`
	`97`	`+ return category == tractusx.RepoCategoryProduct`
	`98`	`+}`