Documentation
¶
Index ¶
- Constants
- Variables
- func NewBufferWriter() *bufferWriter
- func NewGitHubWorkflow(conf CIConfig) *githubWorkflow
- type CIConfig
- func (cc *CIConfig) Branch() string
- func (cc *CIConfig) FnGitHubWorkflowDir(fnRoot string) string
- func (cc *CIConfig) FnGitHubWorkflowFilepath(fnRoot string) string
- func (cc *CIConfig) KubeconfigSecret() string
- func (cc *CIConfig) Path() string
- func (cc *CIConfig) RegistryLoginUrlVar() string
- func (cc *CIConfig) RegistryPassSecret() string
- func (cc *CIConfig) RegistryUrlVar() string
- func (cc *CIConfig) RegistryUserVar() string
- func (cc *CIConfig) UseRegistryLogin() bool
- func (cc *CIConfig) UseRemoteBuild() bool
- func (cc *CIConfig) UseSelfHostedRunner() bool
- func (cc *CIConfig) UseWorkflowDispatch() bool
- func (cc *CIConfig) WorkflowName() string
- type WorkflowWriter
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) FnGitHubWorkflowDir ¶
func (*CIConfig) FnGitHubWorkflowFilepath ¶
func (*CIConfig) KubeconfigSecret ¶
func (*CIConfig) RegistryLoginUrlVar ¶
func (*CIConfig) RegistryPassSecret ¶
func (*CIConfig) RegistryUrlVar ¶
func (*CIConfig) RegistryUserVar ¶
func (*CIConfig) UseRegistryLogin ¶
func (*CIConfig) UseRemoteBuild ¶
func (*CIConfig) UseSelfHostedRunner ¶
func (*CIConfig) UseWorkflowDispatch ¶
func (*CIConfig) WorkflowName ¶
type WorkflowWriter ¶
WorkflowWriter defines the interface for writing workflow files.
Click to show internal directories.
Click to hide internal directories.