Documentation
¶
Index ¶
- Variables
- func CallPlugin(logger hclog.Logger, plugin interface{}) []*protos2.BuildArgsGroup
- func ConfigureUpdate(binaryName, githubOrg, githubRepo string)
- func Engine(cmd *cobra.Command, _ []string) error
- func Execute() error
- func GetBuild(auto bool) container.BuildGroups
- func GetDefaultBuildSteps(arg *container.Build) *build.BuildSteps
- func Init(arg *container.Build) *container.Build
- func InitBuildSteps()
- func LoadCache() error
- func Pre(arg *container.Build) *container.Build
- func RootCmd() *cobra.Command
- func RunCommand(cmd *cobra.Command, args []string) error
- func RunGithub(cmd *cobra.Command, args []string) error
- func RunGithubAction() error
- func RunGithubActionCmd(_ *cobra.Command, args []string) error
- func RunImagesCmd(cmd *cobra.Command, _ []string) error
- func RunInit(cmd *cobra.Command, args []string) error
- func RunMage(cmd *cobra.Command, args []string)
- func SaveCache() error
- func SetUpdateConfig(config *UpdateConfig)
- func SetVersionInfo(version, commit, date, repo string) string
- func Start() (func(), network.Address, error)
- type Command
- type ImageInfo
- type LeaderElection
- type TemplateData
- type UpdateConfig
- type VersionInfo
- type WorkflowTemplate
Constants ¶
This section is empty.
Variables ¶
var RootArgs = &rootCmdArgs{}
Functions ¶
func CallPlugin ¶ added in v0.11.0
func CallPlugin(logger hclog.Logger, plugin interface{}) []*protos2.BuildArgsGroup
func ConfigureUpdate ¶ added in v0.26.1
func ConfigureUpdate(binaryName, githubOrg, githubRepo string)
ConfigureUpdate allows extending projects to configure the update command
func Execute ¶
func Execute() error
Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.
func GetBuild ¶
func GetBuild(auto bool) container.BuildGroups
func GetDefaultBuildSteps ¶ added in v0.30.3
func GetDefaultBuildSteps(arg *container.Build) *build.BuildSteps
GetDefaultBuildSteps returns the current BuildSteps instance with all default build steps. This allows engines to extend the default pipeline instead of replacing it completely.
func InitBuildSteps ¶ added in v0.2.1
func InitBuildSteps()
func RunGithubAction ¶
func RunGithubAction() error
func SetUpdateConfig ¶ added in v0.26.1
func SetUpdateConfig(config *UpdateConfig)
SetUpdateConfig allows full configuration control
func SetVersionInfo ¶ added in v0.3.0
Types ¶
type Command ¶
type Command struct {
// contains filtered or unexported fields
}
func NewCommand ¶
func NewCommand(_buildArgs container.Build, _buildSteps *build.BuildSteps) *Command
type ImageInfo ¶ added in v0.45.0
type ImageInfo struct {
// URI is the full image URI, e.g. docker.io/containifyci/zig-3.24:6f9120d0...
URI string `json:"uri"`
Name string `json:"name"`
Tag string `json:"tag"`
// Registry is the registry host + namespace, e.g. docker.io/containifyci
Registry string `json:"registry"`
// Dockerfile is the repository-relative path to the Dockerfile, e.g. pkg/zig/Dockerfile.zig
Dockerfile string `json:"dockerfile"`
// Context is the repository-relative build context directory (the directory
// containing the Dockerfile), e.g. pkg/zig. This is needed because some
// Dockerfiles (e.g. gcloud) ADD local files from the context.
Context string `json:"context"`
// BuildStep is the name of the engine-ci build step that produces this image, e.g. zig
BuildStep string `json:"build_step"`
}
ImageInfo describes a single intermediate container image.
func CollectImages ¶ added in v0.45.0
func CollectImages() []ImageInfo
CollectImages enumerates all intermediate containifyci container images by iterating the build steps registered in InitBuildSteps() and calling step.IntermediateImages() on each.
type LeaderElection ¶ added in v0.11.0
type LeaderElection struct {
// contains filtered or unexported fields
}
func (*LeaderElection) Leader ¶ added in v0.11.0
func (l *LeaderElection) Leader(id string, fnc func() error)
type TemplateData ¶ added in v0.30.0
type TemplateData struct {
Groups container.BuildGroups
}
TemplateData holds the data passed to the containifyci.go template
type UpdateConfig ¶ added in v0.26.1
type UpdateConfig struct {
UpdateHook func() error
BinaryName string
GitHubOrg string
GitHubRepo string
}
UpdateConfig holds the configuration for the update command
func GetUpdateConfig ¶ added in v0.26.1
func GetUpdateConfig() *UpdateConfig
GetUpdateConfig returns the current update configuration
type VersionInfo ¶ added in v0.31.1
type WorkflowTemplate ¶ added in v0.27.1
WorkflowTemplate represents a GitHub Actions workflow template