some more minor changes

Signed-off-by: Callum Styan <[email protected]>

Author: cstyan

cmd/readmevalidation/contributors.go

@@ -239,12 +239,13 @@ func aggregateContributorReadmeFiles() ([]readme, error) {
 
 	allReadmeFiles := []readme{}
 	errs := []error{}
+	dirPath := ""
 	for _, e := range dirEntries {
 		if !e.IsDir() {
 			continue
 		}
 
-		dirPath := path.Join(rootRegistryPath, e.Name())
+		dirPath = path.Join(rootRegistryPath, e.Name())
 
 		readmePath := path.Join(dirPath, "README.md")
 		rmBytes, err := os.ReadFile(readmePath)
@@ -268,7 +269,7 @@ func aggregateContributorReadmeFiles() ([]readme, error) {
 	return allReadmeFiles, nil
 }
 
-func validateContributorRelativeUrls(contributors map[string]contributorProfileReadme) error {
+func validateContributorRelativeURLs(contributors map[string]contributorProfileReadme) error {
 	// This function only validates relative avatar URLs for now, but it can be beefed up to validate more in the future.
 	errs := []error{}
 
@@ -317,7 +318,7 @@ func validateAllContributorFiles() error {
 	}
 	logger.Info(context.Background(), "Processed README files as valid contributor profiles", "num_contributors", len(contributors))
 
-	if err = validateContributorRelativeUrls(contributors); err != nil {
+	if err = validateContributorRelativeURLs(contributors); err != nil {
 		return err
 	}
 	logger.Info(context.Background(), "All relative URLs for READMEs are valid")

cmd/readmevalidation/main.go

@@ -20,14 +20,14 @@ func main() {
 
 	// If there are fundamental problems with how the repo is structured, we can't make any guarantees that any further
 	// validations will be relevant or accurate.
-	repoErr := validateRepoStructure()
-	if repoErr != nil {
-		logger.Error(context.Background(), repoErr.Error())
+	err := validateRepoStructure()
+	if err != nil {
+		logger.Error(context.Background(), "Error when validating the repo structure", "error", err.Error())
 		os.Exit(1)
 	}
 
 	var errs []error
-	err := validateAllContributorFiles()
+	err = validateAllContributorFiles()
 	if err != nil {
 		errs = append(errs, err)
 	}

cmd/readmevalidation/readmefiles.go

@@ -132,7 +132,8 @@ func validateReadmeBody(body string) []error {
 			continue
 		}
 
-		if spaceAfterHeader := headerGroups[2]; spaceAfterHeader == "" {
+		// In the Markdown spec it is mandatory to have a space following the header # symbol(s).
+		if headerGroups[2] == "" {
 			errs = append(errs, errors.New("header does not have space between header characters and main header text"))
 		}