mirror of
https://github.com/coder/registry.git
synced 2026-06-02 20:48:14 +00:00
Michael Smith
08ed594bfd
Closes #194 alongside #325 ## Description This PR adds the missing base layer of validation for all Coder template README files, ensuring that they all follow a consistent structure when processed by the Registry website's build step. It also updates a few README files to match the new standards. ## Type of Change - [ ] New module - [x] Bug fix - [ ] Feature/enhancement - [ ] Documentation - [x] Other ## Testing & Validation - [x] Tests pass (`bun test`) - [x] Code formatted (`bun run fmt`) - [x] Changes tested locally
52 lines
1.4 KiB
Go
52 lines
1.4 KiB
Go
// This package is for validating all contributors within the main Registry
|
|
// directory. It validates that it has nothing but sub-directories, and that
|
|
// each sub-directory has a README.md file. Each of those files must then
|
|
// describe a specific contributor. The contents of these files will be parsed
|
|
// by the Registry site build step, to be displayed in the Registry site's UI.
|
|
package main
|
|
|
|
import (
|
|
"context"
|
|
"os"
|
|
|
|
"cdr.dev/slog"
|
|
"cdr.dev/slog/sloggers/sloghuman"
|
|
)
|
|
|
|
var logger = slog.Make(sloghuman.Sink(os.Stdout))
|
|
|
|
func main() {
|
|
logger.Info(context.Background(), "starting README validation")
|
|
|
|
// 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.
|
|
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()
|
|
if err != nil {
|
|
errs = append(errs, err)
|
|
}
|
|
err = validateAllCoderModules()
|
|
if err != nil {
|
|
errs = append(errs, err)
|
|
}
|
|
err = validateAllCoderTemplates()
|
|
if err != nil {
|
|
errs = append(errs, err)
|
|
}
|
|
|
|
if len(errs) == 0 {
|
|
logger.Info(context.Background(), "processed all READMEs in directory", "dir", rootRegistryPath)
|
|
os.Exit(0)
|
|
}
|
|
for _, err := range errs {
|
|
logger.Error(context.Background(), err.Error())
|
|
}
|
|
os.Exit(1)
|
|
}
|