Add version subcommand (#31)

* Remove version flag

The flag has never worked. In addition, it's intended to use a dedicated subcommand rather than a global flag.

* Add version subcommand

* Make wording for command help more consistent

Author: timuthy

cmd/gardener-landscape-kit/app/app.go

@@ -9,11 +9,11 @@ import (
 
 	"github.com/spf13/cobra"
 	"k8s.io/cli-runtime/pkg/genericiooptions"
-	"k8s.io/component-base/version/verflag"
 
 	"github.com/gardener/gardener-landscape-kit/pkg/cmd"
 	"github.com/gardener/gardener-landscape-kit/pkg/cmd/generate"
 	"github.com/gardener/gardener-landscape-kit/pkg/cmd/resolveocm"
+	"github.com/gardener/gardener-landscape-kit/pkg/cmd/version"
 )
 
 // Name is a const for the name of this component.
@@ -47,13 +47,13 @@ func NewCommand() *cobra.Command {
 	for _, subcommand := range []*cobra.Command{
 		generate.NewCommand(opts),
 		resolveocm.NewCommand(opts),
+		version.NewCommand(opts),
 	} {
 		cmd.AddCommand(subcommand)
 	}
 
 	flags := cmd.PersistentFlags()
 	opts.AddFlags(flags)
-	verflag.AddFlags(flags)
 
 	return cmd
 }

pkg/cmd/generate/base/base.go

@@ -22,8 +22,7 @@ func NewCommand(globalOpts *cmd.Options) *cobra.Command {
 
 	cmd := &cobra.Command{
 		Use:     "base (-c CONFIG_FILE) TARGET_DIR",
-		Short:   "base generates or updates the base directory",
-		Long:    "Generates or updates base specific directories.",
+		Short:   "Generate or update the base directory",
 		Example: "gardener-landscape-kit generate base -c ./example/20-componentconfig-glk.yaml ./base",
 		Args:    cobra.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {

pkg/cmd/generate/generate.go

@@ -16,7 +16,7 @@ import (
 func NewCommand(globalOpts *cmd.Options) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "generate",
-		Short: "Generates or updates the landscape directories",
+		Short: "Generate or update the landscape directories",
 	}
 
 	for _, subcommand := range []*cobra.Command{

pkg/cmd/generate/landscape/landscape.go

@@ -24,8 +24,7 @@ func NewCommand(globalOpts *cmd.Options) *cobra.Command {
 
 	cmd := &cobra.Command{
 		Use:     "landscape (-c CONFIG_FILE) TARGET_DIR",
-		Short:   "landscape generates or updates the landscape directory",
-		Long:    "Generates or updates landscape specific directories.",
+		Short:   "Generate or update landscape specific directories",
 		Example: "gardener-landscape-kit generate landscape -c ./example/20-componentconfig-glk.yaml ./",
 		Args:    cobra.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {

pkg/cmd/resolveocm/resolve_ocm_components.go

@@ -19,9 +19,9 @@ func NewCommand(globalOpts *cmd.Options) *cobra.Command {
 
 	cmd := &cobra.Command{
 		Use:   "resolve-ocm-components",
-		Short: "Collects all OCM components and their versions and generates component list and image vector files.",
-		Long: "Collects all OCM components by walking all dependencies of the root component descriptor. " +
-			"It outputs the component list and generates the imagevector overwrites for each component.",
+		Short: "Collect all OCM components and their versions and generate component list and image vector files",
+		Long: "Collect all OCM components by walking all dependencies of the root component descriptor. " +
+			"Produce the component list and generate the image vector overwrites for each component.",
 
 		Example: `# Resolve all components starting at the root component. Writes component list, imagevector overwrite files for each component, and dumps all component descriptors.
 

pkg/cmd/version/version.go

@@ -0,0 +1,31 @@
+// SPDX-FileCopyrightText: SAP SE or an SAP affiliate company and Gardener contributors
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package version
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+	utilruntime "k8s.io/apimachinery/pkg/util/runtime"
+	"k8s.io/component-base/version"
+
+	"github.com/gardener/gardener-landscape-kit/pkg/cmd"
+)
+
+// NewCommand creates a new cobra.Command.
+func NewCommand(opts *cmd.Options) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "version",
+		Short: "Print the program version information",
+		Long:  "Print the program version information",
+
+		Run: func(_ *cobra.Command, _ []string) {
+			_, err := fmt.Fprintf(opts.Out, "gardener-landscape-kit Version: %s\n", version.Get())
+			utilruntime.Must(err)
+		},
+	}
+
+	return cmd
+}