Add version command and embed build metadata

Author: adrianpunkt

.github/workflows/build.yml

@@ -51,8 +51,18 @@ jobs:
           fi
 
           out="ticktick-${{ matrix.goos }}-${{ matrix.goarch }}${ext}"
+          if [[ "${GITHUB_REF_TYPE}" == "tag" ]]; then
+            build_version="${GITHUB_REF_NAME}"
+          else
+            build_version="main-${GITHUB_SHA::7}"
+          fi
+          build_commit="${GITHUB_SHA::7}"
+          build_date="$(date -u +%Y-%m-%dT%H:%M:%SZ)"
+
           GOOS="${{ matrix.goos }}" GOARCH="${{ matrix.goarch }}" CGO_ENABLED=0 \
-            go build -trimpath -ldflags="-s -w" -o "dist/${out}" ./cmd/ticktick
+            go build -trimpath \
+              -ldflags="-s -w -X 'main.version=${build_version}' -X 'main.commit=${build_commit}' -X 'main.buildDate=${build_date}'" \
+              -o "dist/${out}" ./cmd/ticktick
 
           (cd dist && sha256sum "${out}" > "${out}.sha256")
 

.github/workflows/release.yml

@@ -49,8 +49,18 @@ jobs:
           fi
 
           out="ticktick-${{ matrix.goos }}-${{ matrix.goarch }}${ext}"
+          if [[ "${GITHUB_REF_TYPE}" == "tag" ]]; then
+            build_version="${GITHUB_REF_NAME}"
+          else
+            build_version="main-${GITHUB_SHA::7}"
+          fi
+          build_commit="${GITHUB_SHA::7}"
+          build_date="$(date -u +%Y-%m-%dT%H:%M:%SZ)"
+
           GOOS="${{ matrix.goos }}" GOARCH="${{ matrix.goarch }}" CGO_ENABLED=0 \
-            go build -trimpath -ldflags="-s -w" -o "dist/${out}" ./cmd/ticktick
+            go build -trimpath \
+              -ldflags="-s -w -X 'main.version=${build_version}' -X 'main.commit=${build_commit}' -X 'main.buildDate=${build_date}'" \
+              -o "dist/${out}" ./cmd/ticktick
 
           (cd dist && sha256sum "${out}" > "${out}.sha256")
           tar -czf "dist/${out}.tar.gz" -C dist "${out}" "${out}.sha256"

README.md

@@ -20,6 +20,12 @@ A Go-based TickTick CLI inspired by the command-oriented style of `gogcli`.
 go build -o ticktick ./cmd/ticktick
 ```
 
+Check version:
+
+```bash
+./ticktick --version
+```
+
 3. Install globally (pick one):
 
 ```bash

cmd/ticktick/main.go

@@ -7,8 +7,18 @@ import (
 	"github.com/apktdev/ticktick-cli/internal/cli"
 )
 
+var (
+	version   = "dev"
+	commit    = "none"
+	buildDate = "unknown"
+)
+
+func buildVersionString() string {
+	return fmt.Sprintf("%s (commit %s, built %s)", version, commit, buildDate)
+}
+
 func main() {
-	if err := cli.NewRootCmd().Execute(); err != nil {
+	if err := cli.NewRootCmd(buildVersionString()).Execute(); err != nil {
 		fmt.Fprintln(os.Stderr, err)
 		os.Exit(1)
 	}

internal/cli/root.go

@@ -18,7 +18,7 @@ type app struct {
 	shouldPersist bool
 }
 
-func NewRootCmd() *cobra.Command {
+func NewRootCmd(version string) *cobra.Command {
 	cfg, err := config.Load()
 	if err != nil {
 		panic(err)
@@ -34,8 +34,9 @@ func NewRootCmd() *cobra.Command {
 		shouldPersist: !envOverride,
 	}
 	root := &cobra.Command{
-		Use:   "ticktick",
-		Short: "TickTick command line client",
+		Use:     "ticktick",
+		Short:   "TickTick command line client",
+		Version: version,
 		PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
 			return nil
 		},
@@ -46,8 +47,16 @@ func NewRootCmd() *cobra.Command {
 			return config.Save(a.cfg)
 		},
 	}
+	root.SetVersionTemplate("{{.Version}}\n")
 	root.PersistentFlags().BoolVar(&a.jsonMode, "json", false, "Output JSON")
 
+	root.AddCommand(&cobra.Command{
+		Use:   "version",
+		Short: "Print version",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			return a.print(version)
+		},
+	})
 	root.AddCommand(a.newAuthCmd())
 	root.AddCommand(a.newProjectsCmd())
 	root.AddCommand(a.newTasksCmd())