piperenv

package

v1.361.0 Latest Latest Go to latest Published: May 13, 2024 License: Apache-2.0 Imports: 10 Imported by: 10

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

View Source

const DEFAULT_END_DELIMITER = "}}"

View Source

const DEFAULT_START_DELIMITER = "{{"

This section is empty.

func GetParameter(path, name string) string

GetParameter reads any parameter from the pipeline environment or another environment stored in the file system

func GetResourceParameter(path, resourceName, paramName string) string

GetResourceParameter reads a resource parameter from the environment stored in the file system

func SetParameter(path, name, value string) error

SetParameter sets any parameter in the pipeline environment or another environment stored in the file system

func SetResourceParameter(path, resourceName, paramName string, value interface{}) error

SetResourceParameter sets a resource parameter in the environment stored in the file system

type Artifact struct {
	Id   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
}

type Artifacts []Artifact

func (a Artifacts) FindByName(name string) Artifacts

type CPEMap map[string]interface{}

CPEMap represents the common pipeline environment map

func (c *CPEMap) LoadFromDisk(path string) error

LoadFromDisk reads the given path from disk and populates it to the CPEMap.

func (c *CPEMap) ParseTemplate(cpeTemplate string) (*bytes.Buffer, error)

ParseTemplate allows to parse a template which contains references to the CPE Utility functions make it simple to access specific parts of the CPE

func (c *CPEMap) ParseTemplateWithDelimiter(cpeTemplate string, startDelimiter string, endDelimiter string) (*bytes.Buffer, error)

func (c CPEMap) WriteToDisk(rootDirectory string) error

WriteToDisk writes the CPEMap to a disk and uses rootDirectory as the starting point