Documentation
¶
Index ¶
Constants ¶
const ( // CONDITIONREPORTTEMPLATE defines CONDITIONREPORTTEMPLATE string = `` /* 190-byte string literal not displayed */ // TARGETREPORTTEMPLATE ... TARGETREPORTTEMPLATE string = `` /* 172-byte string literal not displayed */ // SOURCEREPORTTEMPLATE ... SOURCEREPORTTEMPLATE string = `` /* 169-byte string literal not displayed */ // REPORTTEMPLATE ... REPORTTEMPLATE string = `` /* 833-byte string literal not displayed */ )
Variables ¶
This section is empty.
Functions ¶
func MergeFromString ¶ added in v0.49.0
Types ¶
type Action ¶ added in v0.49.0
type Action struct {
// ID is the unique identifier of the action
ID string `xml:"id,attr" json:"id,omitempty"`
// Title is the title of the action
Title string `xml:"-" json:"title,omitempty"`
// PipelineTitle is the title of the pipeline
PipelineTitle string `xml:"h3,omitempty" json:"pipelineTitle,omitempty"`
// Description is the description of the action
Description string `xml:"p,omitempty" json:"description,omitempty"`
// Targets is the list of targets IDs associated with the action
Targets []ActionTarget `xml:"details,omitempty" json:"targets,omitempty"`
// using a pointer to avoid empty tag
PipelineURL *PipelineURL `xml:"a,omitempty" json:"pipelineURL,omitempty"`
// Link is the URL of the action
Link string `xml:"link,omitempty" json:"actionUrl,omitempty"`
}
Action is a struct used to store the result of an action. It is used to generate pullrequest body
func (Action) ToActionsMarkdownString ¶ added in v0.86.0
ToActionsMarkdownString show an action report formatted as a string using markdown
func (Action) ToActionsString ¶ added in v0.49.0
ToActionsString show an action report formatted as a string
func (*Action) UpdatePipelineURL ¶ added in v0.66.0
func (a *Action) UpdatePipelineURL()
UpdatePipelineURL analyze the local environment to guess if Updatecli is executed from a CI pipeline
type ActionTarget ¶ added in v0.49.0
type ActionTarget struct {
ID string `xml:"id,attr"`
Title string `xml:"summary,omitempty"`
Description string `xml:"p,omitempty"`
Changelogs []ActionTargetChangelog `xml:"details,omitempty"`
}
ActionTarget holds target data to describe an action report
func (*ActionTarget) Merge ¶ added in v0.49.0
func (a *ActionTarget) Merge(sourceActionTarget *ActionTarget, useDetailsFromSourceActionTarget bool)
type ActionTargetChangelog ¶ added in v0.49.0
type ActionTargetChangelog struct {
// Title is the title of the changelog
Title string `xml:"summary,omitempty" json:"title,omitempty"`
// Description is the description of the changelog
Description string `xml:"pre,omitempty" json:"description,omitempty"`
}
ActionTargetChangelog is a struct used to store a target changelog
type PipelineURL ¶ added in v0.66.0
type PipelineURL struct {
// URL is the URL of the pipeline
URL string `xml:"href,attr"`
// Name is the name of the pipeline
Name string `xml:",chardata"`
}
PipelineURL is a struct used to store a pipeline URL
type Report ¶
type Report struct {
Name string
Err string
Result string
// ID defines the report ID
ID string
// PipelineID represents the Updatecli manifest pipelineID
PipelineID string
Actions map[string]*Action
Sources map[string]*result.Source
Conditions map[string]*result.Condition
Targets map[string]*result.Target
ReportURL string
}
Report contains the result of the execution of a pipeline
func (*Report) ExportToYAML ¶ added in v0.99.0
ExportToYAML exports the report to a YAML file in the temporary report directory. The filename is based on the report ID and the current timestamp.
func (*Report) UpdateID ¶ added in v0.55.0
UpdateID generates a unique ID for the report based on the content of the report Ideally the report ID should be the same regardless of the result of the pipeline. The goal is to be able to identify what report corresponds to what pipeline manifest. It's different from the pipelineID which is used to identify an update scenario which could be the result of multiple Updatecli manifests.
type Reports ¶
type Reports []Report
Reports contains a list of report
Source Files