cmd

package

v0.31.3 Latest Latest Go to latest Published: Oct 5, 2025 License: Apache-2.0 Imports: 44 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/containifyci/engine-ci

Links

Open Source Insights

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 LoadCache() error
func Pre(arg *container.Build, bs *build.BuildSteps) (*container.Build, *build.BuildSteps)
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 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
- func NewCommand(_buildArgs container.Build, _buildSteps *build.BuildSteps) *Command
- func (c *Command) AddTarget(name string, fnc func() error)
- func (c *Command) Pre() (*container.Build, *build.BuildSteps)
- func (c *Command) Run(addr network.Address, target string, arg *container.Build) error
- func (c *Command) RunBuild()
type LeaderElection
- func (l *LeaderElection) Leader(id string, fnc func() error)
type TemplateData
type UpdateConfig
- func GetUpdateConfig() *UpdateConfig
type VersionInfo
type WorkflowTemplate

Constants ¶

This section is empty.

Variables ¶

View Source

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 Engine ¶

func Engine(cmd *cobra.Command, _ []string) error

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 Init ¶

func Init(arg *container.Build) *container.Build

func LoadCache ¶

func LoadCache() error

func Pre ¶

func Pre(arg *container.Build, bs *build.BuildSteps) (*container.Build, *build.BuildSteps)

func RootCmd ¶ added in v0.30.1

func RootCmd() *cobra.Command

func RunCommand ¶ added in v0.3.1

func RunCommand(cmd *cobra.Command, args []string) error

func RunGithub ¶

func RunGithub(cmd *cobra.Command, args []string) error

func RunGithubAction ¶

func RunGithubAction() error

func RunGithubActionCmd ¶

func RunGithubActionCmd(_ *cobra.Command, args []string) error

func RunInit ¶ added in v0.30.0

func RunInit(cmd *cobra.Command, args []string) error

RunInit handles the init command with support for auto-discovery

func RunMage ¶

func RunMage(cmd *cobra.Command, args []string)

func SaveCache ¶

func SaveCache() error

func SetUpdateConfig ¶ added in v0.26.1

func SetUpdateConfig(config *UpdateConfig)

SetUpdateConfig allows full configuration control

func SetVersionInfo ¶ added in v0.3.0

func SetVersionInfo(version, commit, date, repo string) string

func Start ¶ added in v0.11.0

func Start() (func(), network.Address, error)

Types ¶

type Command ¶

type Command struct {
	// contains filtered or unexported fields
}

func NewCommand ¶

func NewCommand(_buildArgs container.Build, _buildSteps *build.BuildSteps) *Command

func (*Command) AddTarget ¶

func (c *Command) AddTarget(name string, fnc func() error)

func (*Command) Pre ¶ added in v0.11.0

func (c *Command) Pre() (*container.Build, *build.BuildSteps)

func (*Command) Run ¶

func (c *Command) Run(addr network.Address, target string, arg *container.Build) error

func (*Command) RunBuild ¶ added in v0.11.0

func (c *Command) RunBuild()

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 VersionInfo struct {
	Version string `json:"version"`
	Commit  string `json:"commit"`
	Date    string `json:"date"`
	Repo    string `json:"repo"`
}

type WorkflowTemplate ¶ added in v0.27.1

type WorkflowTemplate struct {
	Name     string
	Filename string
	Content  []byte
}

WorkflowTemplate represents a GitHub Actions workflow template

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
benchmark-runner
regression-tester

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL