Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Chart ¶
type Chart struct {
Name string
SubPath string
File File
NewVersion version.Semver
PreviousVersion version.Semver
}
Chart version, metadata, and contents information.
type Context ¶
type Context struct {
context.Context
Config *v1.Config
Out io.Writer
Token string
PublishStrategy strategies.PublishStrategy
UpdateStrategy strategies.UpdateStrategy
App App
Author Author
Chart Chart
Client client.Client
Files []File
Git Git
Repository Repository
Release Release
// CurrentFile holds a reference to a extras file that is currently being
// worked on when publishing changes. This allows template rendering to
// access information about the file, e.g. .CurrentFile.Path
CurrentFile File
AllowDirty bool
DryRun bool
ShowDiff bool
// contains filtered or unexported fields
}
Context holds information that is used by chart-releaser throughout the update process. Its values get populated and updated as various stages operate on it. It holds all release state.
func NewWithTimeout ¶
NewWithTimeout creates a new v1 Context for the given v1 Config, with an timeout to cancel the context.
func (*Context) CheckDryRun ¶
CheckDryRun checks whether the Context is configured for a dry-run, and if so, to only log the provided error. If it is not in a dry-run state, it will return the same error it was given for the caller to propagate appropriately.
func (*Context) PrintErrors ¶
func (ctx *Context) PrintErrors()
PrintErrors prints any errors encountered and collected by the Context's error collector.
type File ¶
File holds basic data about a file, its previous contents, and its updated contents.
func (*File) HasChanges ¶
HasChanges determines whether the previous contents of the file differ from the new contents of the file.
type Release ¶
type Release struct {
PRTitle string
PRBody string
ChartCommitMsg string
ExtrasCommitMsg string
Matches []*regexp.Regexp
Ignores []*regexp.Regexp
}
Release metadata used for generating the release messages (commits, PRs).
type RepoType ¶
type RepoType string
RepoType defines the type of repository container the Helm Chart.
const (
RepoGithub RepoType = "github"
)
RepoTypes supported by chart-releaser
func ListRepoTypes ¶
func ListRepoTypes() []RepoType
ListRepoTypes returns all of the RepoTypes supported by chart-releaser.
func RepoTypeFromString ¶
RepoTypeFromString gets a RepoType corresponding to a string.
type Repository ¶
Repository metadata.