Make NOTES.txt check optional

Also change command help message to say "NOTES.txt"
redhat-certification · Apr 19, 2024 · 7534f8c · 7534f8c
1 parent 0275f68
commit 7534f8c
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 6 deletions.
diff --git a/internal/chartverifier/checks/checks.go b/internal/chartverifier/checks/checks.go
@@ -39,8 +39,8 @@ const (
 	APIVersion2                  = "v2"
 	ReadmeExist                  = "Chart has a README"
 	ReadmeDoesNotExist           = "Chart does not have a README"
-	NotesExist                   = "Chart does contain NOTES"
-	NotesDoesNotExist            = "Chart does not contain NOTES"
+	NotesExist                   = "Chart does contain NOTES.txt"
+	NotesDoesNotExist            = "Chart does not contain NOTES.txt"
 	NotHelm3Reason               = "API version is not V2, used in Helm 3"
 	Helm3Reason                  = "API version is V2, used in Helm 3"
 	TestTemplatePrefix           = "templates/tests/"

diff --git a/internal/chartverifier/profiles/default.go b/internal/chartverifier/profiles/default.go
@@ -43,7 +43,7 @@ func getDefaultProfile(msg string) *Profile {
 		{Name: fmt.Sprintf("%s/%s", CheckVersion10, apiChecks.ChartTesting), Type: apiChecks.MandatoryCheckType},
 		{Name: fmt.Sprintf("%s/%s", CheckVersion10, apiChecks.RequiredAnnotationsPresent), Type: apiChecks.MandatoryCheckType},
 		{Name: fmt.Sprintf("%s/%s", CheckVersion10, apiChecks.SignatureIsValid), Type: apiChecks.MandatoryCheckType},
-		{Name: fmt.Sprintf("%s/%s", CheckVersion10, apiChecks.HasNotes), Type: apiChecks.MandatoryCheckType},
+		{Name: fmt.Sprintf("%s/%s", CheckVersion10, apiChecks.HasNotes), Type: apiChecks.OptionalCheckType},
 	}
 
 	return &profile

diff --git a/internal/profileconfig/profiles/profile-partner-1.3.yaml b/internal/profileconfig/profiles/profile-partner-1.3.yaml
@@ -35,5 +35,5 @@ checks:
     - name: v1.0/signature-is-valid
       type: Mandatory
     - name: v1.0/has-notes
-      type: Mandatory
+      type: Optional
 
diff --git a/internal/profileconfig/profiles/profile-redhat-1.3.yaml b/internal/profileconfig/profiles/profile-redhat-1.3.yaml
@@ -35,5 +35,4 @@ checks:
     - name: v1.0/signature-is-valid
       type: Mandatory
     - name: v1.0/has-notes
-      type: Mandatory
-
+      type: Optional