Documentation
¶
Index ¶
Constants ¶
View Source
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 string `xml:"id,attr"`
Title string `xml:"-"`
PipelineTitle string `xml:"h3,omitempty"`
Description string `xml:"p,omitempty"`
Targets []ActionTarget `xml:"details,omitempty"`
// using a pointer to avoid empty tag
PipelineUrl *PipelineURL `xml:"a,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)
type ActionTargetChangelog ¶ added in v0.49.0
type ActionTargetChangelog struct {
Title string `xml:"summary,omitempty"`
Description string `xml:"pre,omitempty"`
}
ActionTargetChangelog is a struct used to store a target changelog
type PipelineURL ¶ added in v0.66.0
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
Sources map[string]*result.Source
Conditions map[string]*result.Condition
Targets map[string]*result.Target
ReportURL string
}
Report contains a list of Rules
type Reports ¶
type Reports []Report
Reports contains a list of report
Click to show internal directories.
Click to hide internal directories.