Documentation ¶
Index ¶
- Variables
- type Spec
- type XML
- func (x *XML) Changelog() string
- func (x *XML) Condition(source string, scm scm.ScmHandler, resultCondition *result.Condition) error
- func (x *XML) Read(filename string) error
- func (x *XML) Source(workingDir string, resultSource *result.Source) error
- func (x *XML) Target(source string, scm scm.ScmHandler, dryRun bool, resultTarget *result.Target) (err error)
- func (x *XML) Validate() (err error)
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // ErrSpecFileUndefined is returned when the file is not defined ErrSpecFileUndefined = errors.New("xml file not specified") // ErrSpecPathUndefined is returned when the path is not defined ErrSpecPathUndefined = errors.New("xml path undefined") )
View Source
var ( // ErrWrongSpec is returned when the Spec has wrong content ErrWrongSpec error = errors.New("wrong spec content") )
Functions ¶
This section is empty.
Types ¶
type Spec ¶
type Spec struct { /* "file" define the xml file path to interact with. compatible: * source * condition * target remark: * scheme "https://", "http://", and "file://" are supported in path for source and condition */ File string `yaml:",omitempty"` /* "path" defines the xpath query used for retrieving value from a XML document compatible: * source * condition * target example: * path: "/project/parent/version" * path: "//breakfast_menu/food[0]/name" * path: "//book[@category='WEB']/title" */ Path string `yaml:",omitempty"` /* "value" is the value associated with a xpath query. compatible: * source * condition * target default: when used from a condition or a target, the default value is set to linked source output */ Value string `yaml:",omitempty"` }
"xml" defines the specification for manipulating "xml" files. It can be used as a "source", a "condition", or a "target".
type XML ¶
type XML struct {
// contains filtered or unexported fields
}
XML stores configuration about the file and the key value which needs to be updated.
func (*XML) Changelog ¶
Changelog returns the changelog for this resource, or an empty string if not supported
func (*XML) Condition ¶
Condition checks that a specific xml path contains the correct value at the specified path
Click to show internal directories.
Click to hide internal directories.