Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Streamline schedule builder flags #3543

Merged
merged 1 commit into from
Apr 3, 2024
Merged

Streamline schedule builder flags #3543

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 15 additions & 10 deletions cmd/schedule-builder/cmd/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ limitations under the License.
package cmd

import (
"errors"
"fmt"
"os"

Expand All @@ -32,7 +31,7 @@ import (
var rootCmd = &cobra.Command{
Use: "schedule-builder --config-path path/to/schedule.yaml --type <release>/or/<patch>[--output-file <filename.md>]",
Short: "schedule-builder generate a human readable format of the Kubernetes release schedule",
Example: "schedule-builder --config-path /home/user/kubernetes/sig-release/releases/schedule.yaml --type patch",
Example: "schedule-builder --config-path /home/user/kubernetes/sig-release/releases/schedule.yaml --type release",
SilenceUsage: true,
SilenceErrors: true,
PersistentPreRunE: initLogging,
Expand All @@ -54,6 +53,8 @@ const (
configPathFlag = "config-path"
outputFileFlag = "output-file"
typeFlag = "type"
typePatch = "patch"
typeRelease = "release"
)

var requiredFlags = []string{
Expand All @@ -69,32 +70,36 @@ func Execute() {
}

func init() {
rootCmd.PersistentFlags().StringVar(
rootCmd.PersistentFlags().StringVarP(
&opts.configPath,
configPathFlag,
"c",
"",
"path where can find the schedule.yaml file",
)

rootCmd.PersistentFlags().StringVar(
rootCmd.PersistentFlags().StringVarP(
&opts.outputFile,
outputFileFlag,
"o",
"",
"name of the file that save the schedule to. If not set it will just output to the stdout.",
"name of the file that save the schedule to. If not set, it will just output to the stdout",
)

rootCmd.PersistentFlags().StringVar(
rootCmd.PersistentFlags().StringVarP(
&opts.logLevel,
"log-level",
"l",
"info",
fmt.Sprintf("the logging verbosity, either %s", log.LevelNames()),
)

rootCmd.PersistentFlags().StringVar(
rootCmd.PersistentFlags().StringVarP(
&opts.typeFile,
typeFlag,
"t",
"patch",
"type of file to be produced - release cycle schedule or patch schedule. To be set to `release` or `patch` and respective yaml needs to be supplied with --config-path",
fmt.Sprintf("type of file to be produced - release cycle schedule or patch schedule. To be set to '%s' or '%s' and respective yaml needs to be supplied with '--%s'", typeRelease, typePatch, configPathFlag),
)

for _, flag := range requiredFlags {
Expand Down Expand Up @@ -145,7 +150,7 @@ func run(opts *options) error {
scheduleOut = parseReleaseSchedule(releaseSchedule)

default:
return errors.New("type must be either `release` or `patch`")
return fmt.Errorf("type must be either %q or %q", typeRelease, typePatch)
}

if opts.outputFile != "" {
Expand All @@ -167,7 +172,7 @@ func (o *options) SetAndValidate() error {
logrus.Info("Validating schedule-path options...")

if o.configPath == "" {
return fmt.Errorf("need to set the config-path")
return fmt.Errorf("need to set the '--%s' flag", configPathFlag)
}

return nil
Expand Down