ghval

Documentation

Index

• type GitHubValue
• type StringOrGitHubValue
  • func (v *StringOrGitHubValue) MarshalJSON() ([]byte, error)
  • func (v *StringOrGitHubValue) UnmarshalJSON(value []byte) (err error)
  • func (v *StringOrGitHubValue) Value() *GitHubValue
• type Type

Types

type GitHubValue

type GitHubValue struct {
	// raw value
	Value *string `json:"value"`

	// Path will read the value from the default branch
	Path *string `json:"path"`

	// StructuredJSONPath reads the specified path from the parsed path file.
	// Path has to be defined and has to be in yaml format in order to get the path.
	StructuredJSONPath *string `json:"structuredJSONPath"`

	// Use the commit of the current Pull Request
	PRHead *bool `json:"prHead"`
}

GitHubValue describes a value that will be determined during runtime by - reading a specific file from a path - get the current PR's commit hash

type StringOrGitHubValue

type StringOrGitHubValue struct {
	Type     Type
	StrValue string
	GHValue  GitHubValue
}

func (*StringOrGitHubValue) MarshalJSON

func (v *StringOrGitHubValue) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface.

func (*StringOrGitHubValue) UnmarshalJSON

func (v *StringOrGitHubValue) UnmarshalJSON(value []byte) (err error)

func (*StringOrGitHubValue) Value

func (v *StringOrGitHubValue) Value() *GitHubValue

type Type

type Type int

Type represents the stored type of StringOrGitHubValue.

const (
	String  Type = iota // The IntOrString holds an string.
	GHValue             // The IntOrString holds a GitHubValue.
)