// This package is for validating all the README files present in the Registry // directory. The expectation is that each contributor, module, and template // will have an associated README containing useful metadata. This metadata must // be validated for correct structure during CI, because the files themselves // are parsed and rendered as UI as part of the Registry site build step (the // Registry site itself lives in a separate repo). package main import ( "fmt" "log" "os" "sync" "coder.com/coder-registry/cmd/github" "github.com/go-git/go-git/v5" "github.com/joho/godotenv" ) func main() { log.Println("Beginning README file validation") // Do basic setup err := godotenv.Load() if err != nil { log.Panic(err) } actorUsername, err := actionsActor() if err != nil { log.Panic(err) } ghAPIToken, err := githubAPIToken() if err != nil { log.Panic(err) } // Retrieve data necessary from the GitHub API to help determine whether // certain field changes are allowed log.Printf("Using GitHub API to determine what fields can be set by user %q\n", actorUsername) client, err := github.NewClient(github.ClientInit{ BaseURL: os.Getenv(githubAPIBaseURLKey), APIToken: ghAPIToken, }) if err != nil { log.Panic(err) } tokenUser, err := client.GetUserFromToken() if err != nil { log.Panic(err) } tokenUserStatus, err := client.GetUserOrgStatus("coder", tokenUser.Login) if err != nil { log.Panic(err) } var actorOrgStatus github.OrgStatus if tokenUserStatus == github.OrgStatusMember { actorOrgStatus, err = client.GetUserOrgStatus("coder", actorUsername) if err != nil { log.Panic(err) } } else { log.Println("Provided API token does not belong to a Coder employee. Some README validation steps will be skipped compared to when they run in CI.") } fmt.Printf("Script GitHub actor %q has Coder organization status %q\n", actorUsername, actorOrgStatus.String()) // Start main validation log.Println("Starting README validation") // Validate file structure of main README directory log.Println("Validating directory structure of the README directory") err = validateRepoStructure() if err != nil { log.Panic(err) } // Set up concurrency for validating each category of README file var readmeValidationErrors []error errChan := make(chan error, 1) wg := sync.WaitGroup{} go func() { for err := range errChan { readmeValidationErrors = append(readmeValidationErrors, err) } }() // Validate contributor README files wg.Add(1) go func() { defer wg.Done() allReadmeFiles, err := aggregateContributorReadmeFiles() if err != nil { errChan <- err return } log.Printf("Processing %d README files\n", len(allReadmeFiles)) contributors, err := parseContributorFiles(allReadmeFiles) log.Printf("Processed %d README files as valid contributor profiles", len(contributors)) if err != nil { errChan <- err return } err = validateContributorRelativeUrls(contributors) if err != nil { errChan <- err return } log.Println("All relative URLs for READMEs are valid") log.Printf("Processed all READMEs in the %q directory\n", rootRegistryPath) }() // Validate modules wg.Add(1) go func() { defer wg.Done() baseRefReadmeFiles, err := aggregateCoderResourceReadmeFiles("modules") if err != nil { errChan <- err return } fmt.Printf("------ got %d back\n", len(baseRefReadmeFiles)) repo, err := git.PlainOpenWithOptions(".", &git.PlainOpenOptions{ DetectDotGit: false, EnableDotGitCommonDir: false, }) if err != nil { errChan <- err return } head, err := repo.Head() if err != nil { errChan <- err return } activeBranchName := head.Name().Short() fmt.Println("-----", activeBranchName) }() // Validate templates wg.Add(1) go func() { defer wg.Done() }() // Clean up and log errors wg.Wait() close(errChan) for _, err := range readmeValidationErrors { log.Println(err) } if len(readmeValidationErrors) != 0 { os.Exit(1) } }