Add version command

Author: csweichel

components/local-app/BUILD.js

@@ -7,7 +7,7 @@ const generatePackage = function (goos, goarch, binaryName, mainFile) {
     let pkg = {
         name,
         type: "go",
-        srcs: ["go.mod", "go.sum", "**/*.go"],
+        srcs: ["go.mod", "go.sum", "**/*.go", "version.txt"],
         deps: [
             "components/supervisor-api/go:lib",
             "components/gitpod-protocol/go:lib",
@@ -19,14 +19,12 @@ const generatePackage = function (goos, goarch, binaryName, mainFile) {
             packaging: "app",
             dontTest: dontTest,
             buildCommand: [
-                "go",
-                "build",
-                "-trimpath",
-                "-ldflags",
-                "-buildid= -w -s -X 'github.com/gitpod-io/local-app/pkg/constants.Version=commit-${__git_commit}'",
-                "-o",
-                binaryName,
-                mainFile,
+                "sh",
+                "-c",
+                'go build -trimpath -ldflags "-X github.com/gitpod-io/local-app/pkg/constants.GitCommit=${__git_commit} -X github.com/gitpod-io/local-app/pkg/constants.BuildTime=$(date +%s)" -o ' +
+                    binaryName +
+                    " " +
+                    mainFile,
             ],
         },
         binaryName,

components/local-app/README.md

@@ -41,6 +41,11 @@ leeway run components/local-app:install-cli
 leeway run components/local-app:cli-completion
 ```
 
+### Versioning and Release Management
+
+The CLI is versioned independently of other Gitpod artifacts due to its auto-updating behaviour.
+To create a new version that existing clients will consume increment the number in `version.txt`. Make sure to use semantic versioning. The minor version can be greater than 10, e.g. `0.342` is a valid version.
+
 ## local-app
 
 **Beware**: this is very much work in progress and will likely break things.

components/local-app/cmd/version.go

@@ -0,0 +1,35 @@
+// Copyright (c) 2023 Gitpod GmbH. All rights reserved.
+// Licensed under the GNU Affero General Public License (AGPL).
+// See License.AGPL.txt in the project root for license information.
+
+package cmd
+
+import (
+	"time"
+
+	"github.com/gitpod-io/local-app/pkg/constants"
+	"github.com/gitpod-io/local-app/pkg/prettyprint"
+	"github.com/spf13/cobra"
+)
+
+var versionCmd = &cobra.Command{
+	Use:   "version",
+	Short: "Prints the CLI version",
+	RunE: func(cmd *cobra.Command, args []string) error {
+		type Version struct {
+			Version   string `print:"version"`
+			GitCommit string `print:"commit"`
+			BuildTime string `print:"built at"`
+		}
+		v := Version{
+			Version:   constants.Version,
+			GitCommit: constants.GitCommit,
+			BuildTime: constants.MustParseBuildTime().Format(time.RFC3339),
+		}
+		return WriteTabular([]Version{v}, formatOpts{}, prettyprint.WriterFormatNarrow)
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(versionCmd)
+}

components/local-app/pkg/constants/constants.go

@@ -4,7 +4,36 @@
 
 package constants
 
+import (
+	_ "embed"
+	"fmt"
+	"strconv"
+	"strings"
+	"time"
+
+	version "github.com/gitpod-io/local-app"
+)
+
 var (
-	// Version - set during build
-	Version = "dev"
+	// Version is fed from the main CLI version
+	Version = strings.TrimSpace(version.Version)
+
+	// GitCommit - set during build
+	GitCommit = "unknown"
+
+	// BuildTime - set during build
+	BuildTime = "unknown"
 )
+
+// MustParseBuildTime parses the build time or panics
+func MustParseBuildTime() time.Time {
+	if BuildTime == "unknown" {
+		return time.Time{}
+	}
+
+	sec, err := strconv.ParseInt(BuildTime, 10, 64)
+	if err != nil {
+		panic(fmt.Sprintf("cannot parse build time: %v", err))
+	}
+	return time.Unix(sec, 0)
+}

components/local-app/version.go

@@ -0,0 +1,10 @@
+// Copyright (c) 2023 Gitpod GmbH. All rights reserved.
+// Licensed under the GNU Affero General Public License (AGPL).
+// See License.AGPL.txt in the project root for license information.
+
+package version
+
+import _ "embed"
+
+//go:embed "version.txt"
+var Version string

components/local-app/version.txt

@@ -0,0 +1 @@
+v0.1