Merge pull request #67 from AryaHassanli/errata-path-arg

Add support for custom errata YAML using errata-path CLI argument

Author: AryaHassanli

errata/load.go

@@ -16,8 +16,8 @@ import (
 //go:embed default.yaml
 var defaultErrata []byte
 
-func LoadErrata(config *config.Config) (*Collection, error) {
-	b := loadErrataFile(config.Root())
+func LoadErrata(config *config.Config, errataPath string) (*Collection, error) {
+	b := loadErrataFile(config.Root(), errataPath)
 	if b == nil {
 		b = defaultErrata
 	}
@@ -82,11 +82,16 @@ type overlayErrata struct {
 	ZAP      *SDK      `yaml:"zap,omitempty"`
 }
 
-func loadErrataFile(specRoot string) []byte {
-	if specRoot == "" {
-		return nil
+func loadErrataFile(specRoot string, overridePath string) []byte {
+	var errataPath string
+	if overridePath != "" {
+		errataPath = overridePath
+	} else {
+		if specRoot == "" {
+			return nil
+		}
+		errataPath = filepath.Join(specRoot, ".github/alchemy/errata.yaml")
 	}
-	errataPath := filepath.Join(specRoot, ".github/alchemy/errata.yaml")
 	exists, err := files.Exists(errataPath)
 	if err != nil {
 		slog.Warn("error checking for errata path", slog.Any("error", err))

matter/spec/option.go

@@ -31,7 +31,8 @@ func (bo BuilderOptions) List() (options []BuilderOption) {
 }
 
 type ParserOptions struct {
-	Root string `name:"spec-root" default:"connectedhomeip-spec" aliases:"specRoot" help:"the src root of your clone of CHIP-Specifications/connectedhomeip-spec"  group:"Spec:"`
+	Root       string `name:"spec-root" default:"connectedhomeip-spec" aliases:"specRoot" help:"the src root of your clone of CHIP-Specifications/connectedhomeip-spec" group:"Spec:"`
+	ErrataPath string `name:"errata-path" help:"the path to the errata file" group:"Spec:"`
 }
 
 func (po *ParserOptions) AfterApply() error {
@@ -49,6 +50,21 @@ func (po *ParserOptions) AfterApply() error {
 	if !exists {
 		return fmt.Errorf("spec root \"%s\" does not exist", po.Root)
 	}
+	if po.ErrataPath != "" {
+		if !filepath.IsAbs(po.ErrataPath) {
+			po.ErrataPath, err = filepath.Abs(po.ErrataPath)
+			if err != nil {
+				return err
+			}
+		}
+		exists, err = files.Exists(po.ErrataPath)
+		if err != nil {
+			return err
+		}
+		if !exists {
+			return fmt.Errorf("errata path \"%s\" does not exist", po.ErrataPath)
+		}
+	}
 	return nil
 }
 

matter/spec/pipeline.go

@@ -29,7 +29,7 @@ func Build(cxt context.Context, parserOptions ParserOptions, processingOptions p
 	}
 
 	var ec *errata.Collection
-	ec, err = errata.LoadErrata(cfg)
+	ec, err = errata.LoadErrata(cfg, parserOptions.ErrataPath)
 	if err != nil {
 		return
 	}