feat: add flags for all configurable parameters

Add command-line flags for CI configuration. This makes all
configuration explicit and user-controllable at the command level.

- Replace NewGithubWorkflow's 10 parameters with single CIConfig
- Extract hardcoded defaults to named constants
- Add branch configuration option
- Remove temporary ciConfig parameter from command constructors

The NewCiGithubConfigVia function now reads all configuration
directly from command flags, eliminating the need to construct
and pass config objects through the call chain.

Issue SRVOCF-744

Signed-off-by: Stanislav Jakuschevskij <sjakusch@redhat.com>

Author: twoGiants

cmd/ci/config.go

@@ -11,6 +11,7 @@ import (
 type CIConfig struct {
 	githubWorkflowDir,
 	githubWorkflowFilename,
+	branch,
 	workflowName,
 	kubeconfigSecret,
 	registryLoginUrlVar,
@@ -35,6 +36,10 @@ func (cc *CIConfig) WorkflowName() string {
 	return cc.workflowName
 }
 
+func (cc *CIConfig) Branch() string {
+	return cc.branch
+}
+
 func (cc *CIConfig) UseRegistryLogin() bool {
 	return cc.useRegistryLogin
 }
@@ -78,19 +83,19 @@ type ciConfigBuilder struct {
 func NewCIConfigBuilder() *ciConfigBuilder {
 	return &ciConfigBuilder{
 		result: CIConfig{
-			// TODO(twoGiants): extract into constants
-			githubWorkflowDir:      ".github/workflows",
-			githubWorkflowFilename: "remote-build-and-deploy.yaml",
-			workflowName:           "Remote Build and Deploy",
-			kubeconfigSecret:       "KUBECONFIG",
-			registryLoginUrlVar:    "REGISTRY_LOGIN_URL",
-			registryUserVar:        "REGISTRY_USERNAME",
-			registryPassSecret:     "REGISTRY_PASSWORD",
-			registryUrlVar:         "REGISTRY_URL",
-			useRegistryLogin:       true,
-			useRemoteBuild:         false,
-			useSelfHostedRunner:    false,
-			debug:                  false,
+			githubWorkflowDir:      DefaultGithubWorkflowDir,
+			githubWorkflowFilename: DefaultGithubWorkflowFilename,
+			branch:                 DefaultBranch,
+			workflowName:           DefaultWorkflowName,
+			kubeconfigSecret:       DefaultKubeconfigSecretName,
+			registryLoginUrlVar:    DefaultRegistryLoginUrlVariableName,
+			registryUserVar:        DefaultRegistryUserVariableName,
+			registryPassSecret:     DefaultRegistryPassSecretName,
+			registryUrlVar:         DefaultRegistryUrlVariableName,
+			useRegistryLogin:       DefaultUseRegistryLogin,
+			useRemoteBuild:         DefaultUseRemoteBuild,
+			useSelfHostedRunner:    DefaultUseSelfHostedRunner,
+			debug:                  DefaultUseDebug,
 		},
 	}
 }
@@ -100,6 +105,11 @@ func (b *ciConfigBuilder) WithWorkflowName(name string) *ciConfigBuilder {
 	return b
 }
 
+func (b *ciConfigBuilder) WithBranch(v string) *ciConfigBuilder {
+	b.result.branch = v
+	return b
+}
+
 func (b *ciConfigBuilder) WithKubeconfigSecret(v string) *ciConfigBuilder {
 	b.result.kubeconfigSecret = v
 	return b
@@ -110,6 +120,11 @@ func (b *ciConfigBuilder) WithRegistryLoginUrlVar(v string) *ciConfigBuilder {
 	return b
 }
 
+func (b *ciConfigBuilder) WithRegistryUrlVar(v string) *ciConfigBuilder {
+	b.result.registryUrlVar = v
+	return b
+}
+
 func (b *ciConfigBuilder) WithRegistryUserVar(v string) *ciConfigBuilder {
 	b.result.registryUserVar = v
 	return b
@@ -145,14 +160,38 @@ func (b *ciConfigBuilder) Build() CIConfig {
 }
 
 const (
-	UseRegistryLoginOption       = "use-registry-login"
-	DefaultUseRegistryLoginValue = true
+	GithubOption  = "github"
+	DefaultGithub = false
+
+	DefaultGithubWorkflowDir      = ".github/workflows"
+	DefaultGithubWorkflowFilename = "func-deploy.yaml"
+
+	BranchOption  = "branch"
+	DefaultBranch = "main"
 
 	WorkflowNameOption  = "workflow-name"
-	DefaultWorkflowName = "Local Build and Remote Deploy"
+	DefaultWorkflowName = "Func Deploy"
 
-	UseDebugOption       = "debug"
-	DefaultUseDebugValue = false
+	KubeconfigSecretNameOption  = "kubeconfig-secret-name"
+	DefaultKubeconfigSecretName = "KUBECONFIG"
+
+	RegistryLoginUrlVariableNameOption  = "registry-login-url-variable-name"
+	DefaultRegistryLoginUrlVariableName = "REGISTRY_LOGIN_URL"
+
+	RegistryUserVariableNameOption  = "registry-user-variable-name"
+	DefaultRegistryUserVariableName = "REGISTRY_USERNAME"
+
+	RegistryPassSecretNameOption  = "registry-pass-secret-name"
+	DefaultRegistryPassSecretName = "REGISTRY_PASSWORD"
+
+	RegistryUrlVariableNameOption  = "registry-url-variable-name"
+	DefaultRegistryUrlVariableName = "REGISTRY_URL"
+
+	UseRegistryLoginOption  = "use-registry-login"
+	DefaultUseRegistryLogin = true
+
+	UseDebugOption  = "debug"
+	DefaultUseDebug = false
 
 	UseRemoteBuild        = "remote"
 	DefaultUseRemoteBuild = false
@@ -170,6 +209,42 @@ func NewCiGithubConfigVia(cmd *cobra.Command) (CIConfig, error) {
 	}
 	result.WithWorkflowName(workflowName)
 
+	branch, err := cmd.Flags().GetString(BranchOption)
+	if err != nil {
+		return CIConfig{}, err
+	}
+	result.WithBranch(branch)
+
+	kubeconfigSecretName, err := cmd.Flags().GetString(KubeconfigSecretNameOption)
+	if err != nil {
+		return CIConfig{}, err
+	}
+	result.WithKubeconfigSecret(kubeconfigSecretName)
+
+	registryLoginUrlName, err := cmd.Flags().GetString(RegistryLoginUrlVariableNameOption)
+	if err != nil {
+		return CIConfig{}, err
+	}
+	result.WithRegistryLoginUrlVar(registryLoginUrlName)
+
+	registryUserVarName, err := cmd.Flags().GetString(RegistryUserVariableNameOption)
+	if err != nil {
+		return CIConfig{}, err
+	}
+	result.WithRegistryUserVar(registryUserVarName)
+
+	registryPassSecretName, err := cmd.Flags().GetString(RegistryPassSecretNameOption)
+	if err != nil {
+		return CIConfig{}, err
+	}
+	result.WithRegistryPassSecret(registryPassSecretName)
+
+	registryUrlVarName, err := cmd.Flags().GetString(RegistryUrlVariableNameOption)
+	if err != nil {
+		return CIConfig{}, err
+	}
+	result.WithRegistryUrlVar(registryUrlVarName)
+
 	registryLogin, err := cmd.Flags().GetBool(UseRegistryLoginOption)
 	if err != nil {
 		return CIConfig{}, err
@@ -205,6 +280,7 @@ func NewCiGithubConfigVia(cmd *cobra.Command) (CIConfig, error) {
 	return result.Build(), nil
 }
 
+// TODO(twoGiants): fix broken viper cmd options propagation
 func NewCiGithubConfigViaViper() CIConfig {
 	result := NewCIConfigBuilder().
 		WithWorkflowName(viper.GetString(WorkflowNameOption))

cmd/ci/workflow.go

@@ -93,24 +93,13 @@ func (s *Step) withActionConfig(key, value string) *Step {
 	return s
 }
 
-func NewGithubWorkflow(
-	name,
-	kubeconfigSecret,
-	registryLoginUrlVar,
-	registryUserEnvVar,
-	registryPassSecret,
-	registryUrlVar string,
-	useRegistryLogin,
-	useRemoteBuild,
-	useSelfHosted,
-	useDebug bool,
-) *GithubWorkflow {
+func NewGithubWorkflow(conf CIConfig) *GithubWorkflow {
 	runsOn := "ubuntu-latest"
-	if useSelfHosted {
+	if conf.UseSelfHostedRunner() {
 		runsOn = "self-hosted"
 	}
 
-	pushTrigger := newPushTrigger("main", useDebug)
+	pushTrigger := newPushTrigger(conf.Branch(), conf.UseDebug())
 
 	var steps []Step
 	checkoutCode := newStep("Checkout code").
@@ -120,19 +109,19 @@ func NewGithubWorkflow(
 	setupK8Context := newStep("Setup Kubernetes context").
 		withUses("azure/k8s-set-context@v4").
 		withActionConfig("method", "kubeconfig").
-		withActionConfig("kubeconfig", newSecret(kubeconfigSecret))
+		withActionConfig("kubeconfig", newSecret(conf.KubeconfigSecret()))
 	steps = append(steps, *setupK8Context)
 
-	if useRegistryLogin {
+	if conf.UseRegistryLogin() {
 		loginToContainerRegistry := newStep("Login to container registry").
 			withUses("docker/login-action@v3").
-			withActionConfig("registry", newVariable(registryLoginUrlVar)).
-			withActionConfig("username", newVariable(registryUserEnvVar)).
-			withActionConfig("password", newSecret(registryPassSecret))
+			withActionConfig("registry", newVariable(conf.RegistryLoginUrlVar())).
+			withActionConfig("username", newVariable(conf.RegistryUserVar())).
+			withActionConfig("password", newSecret(conf.RegistryPassSecret()))
 		steps = append(steps, *loginToContainerRegistry)
 	}
 
-	if useDebug {
+	if conf.UseDebug() {
 		funcCliCache := newStep("Restore func cli from cache").
 			withID("func-cli-cache").
 			withUses("actions/cache@v4").
@@ -145,19 +134,26 @@ func NewGithubWorkflow(
 		withUses("gauron99/knative-func-action@main").
 		withActionConfig("version", "knative-v1.19.1").
 		withActionConfig("name", "func")
-	if useDebug {
+	if conf.UseDebug() {
 		installFuncCli.withIf("${{ steps.func-cli-cache.outputs.cache-hit != 'true' }}")
 	}
 	steps = append(steps, *installFuncCli)
 
+	if conf.UseDebug() {
+		addFuncToPATH := newStep("Add func to GITHUB_PATH").
+			withRun(`echo "$GITHUB_WORKSPACE" >> $GITHUB_PATH`)
+		steps = append(steps, *addFuncToPATH)
+	}
+
+	name := conf.WorkflowName()
 	runFuncDeploy := "func deploy"
-	if useRemoteBuild {
+	if conf.UseRemoteBuild() {
 		runFuncDeploy += " --remote"
-		name = "Remote Build and Deploy"
+		name = "Remote Func Deploy"
 	}
-	registryUrl := newVariable(registryUrlVar)
-	if useRegistryLogin {
-		registryUrl = newVariable(registryLoginUrlVar) + "/" + newVariable(registryUserEnvVar)
+	registryUrl := newVariable(conf.RegistryUrlVar())
+	if conf.UseRegistryLogin() {
+		registryUrl = newVariable(conf.RegistryLoginUrlVar()) + "/" + newVariable(conf.RegistryUserVar())
 	}
 	deployFunc := newStep("Deploy function").
 		withRun(runFuncDeploy + " --registry=" + registryUrl + " -v")

cmd/ci/workflow_test.go

@@ -9,19 +9,8 @@ import (
 
 func TestGithubWorkflow_PersistAndLoad(t *testing.T) {
 	// GIVEN
-	gw := ci.NewGithubWorkflow(
-		"gw-test",
-		"KUBECONFIG",
-		"REGISTRY_LOGIN_URL",
-		"REGISTRY_USERNAME",
-		"REGISTRY_PASSWORD",
-		"REGISTRY_URL",
-		false,
-		false,
-		false,
-		false)
-	tempDir := t.TempDir()
-	targetPath := tempDir + "/" + gw.Name + ".yaml"
+	gw := ci.NewGithubWorkflow(ci.NewCIConfigBuilder().Build())
+	targetPath := t.TempDir() + "/" + gw.Name + ".yaml"
 
 	// WHEN
 	persistErr := gw.Persist(targetPath)

cmd/config.go

@@ -7,14 +7,12 @@ import (
 	"github.com/ory/viper"
 	"github.com/spf13/cobra"
 
-	"knative.dev/func/cmd/ci"
 	"knative.dev/func/cmd/common"
 	"knative.dev/func/pkg/config"
 	fn "knative.dev/func/pkg/functions"
 )
 
-// TODO(twoGiants): decide if you want to remove TEMP_ciConfig and init somewhere else
-func NewConfigCmd(loadSaver common.FunctionLoaderSaver, newClient ClientFactory, TEMP_ciConfig ci.CIConfig) *cobra.Command {
+func NewConfigCmd(loadSaver common.FunctionLoaderSaver, newClient ClientFactory) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "config",
 		Short: "Configure a function",
@@ -40,7 +38,7 @@ or from the directory specified with --path.
 	cmd.AddCommand(NewConfigLabelsCmd(loadSaver))
 	cmd.AddCommand(NewConfigEnvsCmd(loadSaver))
 	cmd.AddCommand(NewConfigVolumesCmd())
-	cmd.AddCommand(NewConfigCICmd(loadSaver, TEMP_ciConfig))
+	cmd.AddCommand(NewConfigCICmd(loadSaver))
 
 	return cmd
 }