Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var CommandVersionTemplate = heredoc.Doc(`
chart-releaser:
version: {{ .Version }}
build date: {{ .BuildDate }}
commit: {{ .Commit }}
tag: {{ .Tag }}
go version: {{ .GoVersion }}
go compiler: {{ .Compiler }}
platform: {{ .OS }}/{{ .Arch }}
`)
CommandVersionTemplate is the template for the CLI version output.
var ConfigFileTemplate = heredoc.Doc(`
{{ .Header }}
version: v1
chart:
name: {{ .Chart }}{{ if .Path }}
path: {{ .Path }}{{ end }}
repo: github.com/{{ .GithubOwner }}/{{ .GithubName }}
commit:
author:
name: {{ .AuthorName }}
email: {{ .AuthorEmail }}
`)
ConfigFileTemplate is the template used to generate a new basic configuration file for chart-releaser from the `init` command.
var ConfigHeaderComment = heredoc.Doc(`
# .chartreleaser.yaml is the configuration file for chart-releaser, a CI tool
# to update Helm Charts on application release. See the documentation at
# https://github.com/edaniszewski/chart-releaser
`)
ConfigHeaderComment is the header comment which is applied to the generated config file.
var DefaultBranchName = `chartreleaser/{{ .Chart.Name }}/{{ .Chart.NewVersion }}`
DefaultBranchName is a template specifying the default name of the branch to create when updating under the "pull request" strategy.
var DefaultExtrasCommitMessage = `[{{ .Chart.Name }}] update {{ .CurrentFile.Path }} for new application release ({{ .App.NewVersion }})`
DefaultExtrasCommitMessage is the default template for a commit message used when updating a file specified in the `extras` config.
var DefaultPullRequestBody = heredoc.Doc(`
Bumps the {{ .Chart.Name }} Helm Chart from {{ .Chart.PreviousVersion }} to {{ .Chart.NewVersion }}.
{{ if .Files }}The following files have also been updated:
{{ range .Files }}- {{ .Path }}
{{ end }}{{ end }}
---
*This PR was generated with [chart-releaser](https://github.com/edaniszewski/chart-releaser)*
`)
DefaultPullRequestBody is a template for the default comment used when opening a new pull request, summarizing the changes.
This is only used when the configuration specifies that a pull request should be opened after committing any updates.
var DefaultPullRequestTitle = `Bump {{ .Chart.Name }} Chart from {{ .Chart.PreviousVersion }} to {{ .Chart.NewVersion }}`
DefaultPullRequestTitle is a template for the default title used when opening a pull request for the updates generated by chart-releaser.
This is only used when the configuration specifies that a pull request should be opened after committing any updates.
var DefaultUpdateCommitMessage = `[{{ .Chart.Name }}] bump chart to {{ .Chart.NewVersion }} for new application release ({{ .App.NewVersion }})`
DefaultUpdateCommitMessage is the default template for a commit message used when updating the Chart file.
var FlagLatestVersionTemplate = heredoc.Doc(`
{{ .Status }}
latest: {{ .Latest }}
installed: {{ .Installed }}
`)
FlagLatestVersionTemplate is the template for the output when the --latest flag is specified.
Functions ¶
This section is empty.
Types ¶
This section is empty.
Source Files