ci

package
v0.48.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 28, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source
const (
	ConfigCIFeatureFlag = "FUNC_ENABLE_CI_CONFIG"

	PathFlag = "path"

	PlatformFlag    = "platform"
	DefaultPlatform = "github"

	DefaultGitHubWorkflowDir      = ".github/workflows"
	DefaultGitHubWorkflowFilename = "func-deploy.yaml"

	BranchFlag    = "branch"
	DefaultBranch = "main"

	WorkflowNameFlag    = "workflow-name"
	DefaultWorkflowName = "Func Deploy"

	KubeconfigSecretNameFlag    = "kubeconfig-secret-name"
	DefaultKubeconfigSecretName = "KUBECONFIG"

	RegistryLoginUrlVariableNameFlag    = "registry-login-url-variable-name"
	DefaultRegistryLoginUrlVariableName = "REGISTRY_LOGIN_URL"

	RegistryUserVariableNameFlag    = "registry-user-variable-name"
	DefaultRegistryUserVariableName = "REGISTRY_USERNAME"

	RegistryPassSecretNameFlag    = "registry-pass-secret-name"
	DefaultRegistryPassSecretName = "REGISTRY_PASSWORD"

	RegistryUrlVariableNameFlag    = "registry-url-variable-name"
	DefaultRegistryUrlVariableName = "REGISTRY_URL"

	UseRegistryLoginFlag    = "use-registry-login"
	DefaultUseRegistryLogin = true

	WorkflowDispatchFlag    = "workflow-dispatch"
	DefaultWorkflowDispatch = false

	UseRemoteBuildFlag    = "remote"
	DefaultUseRemoteBuild = false

	UseSelfHostedRunnerFlag    = "self-hosted-runner"
	DefaultUseSelfHostedRunner = false
)

Variables

View Source
var DefaultWorkflowWriter = &fileWriter{}

DefaultWorkflowWriter is the default implementation for writing workflow files to disk.

Functions

func NewBufferWriter

func NewBufferWriter() *bufferWriter

NewBufferWriter creates a new bufferWriter for testing purposes.

func NewGitHubWorkflow

func NewGitHubWorkflow(conf CIConfig) *githubWorkflow

Types

type CIConfig

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

CIConfig readonly configuration

func NewCIConfig

func NewCIConfig(
	currentBranch common.CurrentBranchFunc,
	workingDir common.WorkDirFunc,
) (CIConfig, error)

func (*CIConfig) Branch

func (cc *CIConfig) Branch() string

func (*CIConfig) FnGitHubWorkflowDir

func (cc *CIConfig) FnGitHubWorkflowDir(fnRoot string) string

func (*CIConfig) FnGitHubWorkflowFilepath

func (cc *CIConfig) FnGitHubWorkflowFilepath(fnRoot string) string

func (*CIConfig) KubeconfigSecret

func (cc *CIConfig) KubeconfigSecret() string

func (*CIConfig) Path

func (cc *CIConfig) Path() string

func (*CIConfig) RegistryLoginUrlVar

func (cc *CIConfig) RegistryLoginUrlVar() string

func (*CIConfig) RegistryPassSecret

func (cc *CIConfig) RegistryPassSecret() string

func (*CIConfig) RegistryUrlVar

func (cc *CIConfig) RegistryUrlVar() string

func (*CIConfig) RegistryUserVar

func (cc *CIConfig) RegistryUserVar() string

func (*CIConfig) UseRegistryLogin

func (cc *CIConfig) UseRegistryLogin() bool

func (*CIConfig) UseRemoteBuild

func (cc *CIConfig) UseRemoteBuild() bool

func (*CIConfig) UseSelfHostedRunner

func (cc *CIConfig) UseSelfHostedRunner() bool

func (*CIConfig) UseWorkflowDispatch

func (cc *CIConfig) UseWorkflowDispatch() bool

func (*CIConfig) WorkflowName

func (cc *CIConfig) WorkflowName() string

type WorkflowWriter

type WorkflowWriter interface {
	Write(path string, raw []byte) error
}

WorkflowWriter defines the interface for writing workflow files.

Jump to

Keyboard shortcuts

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