ocpaths

package

v0.0.0-...-2661cfd Latest Latest Go to latest Published: Jun 5, 2024 License: Apache-2.0 Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package ocpaths contains utilities and types for validating a set of OCPaths specified by ocpaths.proto.

This section is empty.

This section is empty.

func ClonePublicRepo(downloadPath, branch string) (string, error)

ClonePublicRepo clones the openconfig/public repo at the given path.

branch is the branch to be downloaded (passed to git clone -b). If it is empty then the argument will be omitted.

If the "public" folder already exists, then no additional downloads will be made.
A manual deletion of the downloadPath folder is required if no longer used.

func ValidatePaths(ocpathsProto []*ppb.OCPath, publicPath string) (map[OCPathKey]*OCPath, map[OCPathKey]*OCPath, error)

ValidatePaths parses and validates ocpaths, and puts them into a more user-friendly Go structure.

The first set of paths contain only valid path, while the second contain only invalid paths.

type OCPath struct {
	Key              OCPathKey
	FeatureprofileID string
}

OCPath is the parsed version of the spreadsheet's paths.

type OCPathKey struct {
	Path         string
	PlatformType string
}

OCPathKey contains the fields that uniquely identify an OC path.