Merge pull request #2 from tlkamp/version

feat: add version command

.github/workflows/goreleaser.yaml

@@ -16,4 +16,4 @@ jobs:
         with:
           args: release --rm-dist
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.PAT }}

.goreleaser.yml

@@ -17,3 +17,5 @@ changelog:
       - '^docs:'
       - '^test:'
       - '^style:'
+release:
+  github:

README.md

@@ -2,19 +2,36 @@
 A CLI for the Litter Robot 3.
 
 ## Usage
+<details>
+<summary>Basic</summary>
+
 ```console
+$ litterrobot
 Control your Litter Robot 3 Connect
 
 Usage:
   litterrobot [command]
 
 Available Commands:
   completion  Generate the autocompletion script for the specified shell
-  config      Manage local configuration for the CLI
   help        Help about any command
+  version     print the version information
 
 Flags:
   -h, --help   help for litterrobot
 
 Use "litterrobot [command] --help" for more information about a command.
-```
+```
+
+</details>
+
+<details>
+<summary>Version</summary>
+
+```console
+$ litterrobot version
+$TAG - $COMMIT - $DATE
+```
+
+</details>
+

internal/cmd/root.go

@@ -9,7 +9,7 @@ import (
 	lrc "github.com/tlkamp/litter-api/v2/pkg/client"
 )
 
-func newLitterRobotCmd(c *lrc.Client) *cobra.Command {
+func newLitterRobotCmd(c *lrc.Client, version string) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "litterrobot",
 		Short: "Control your Litter Robot 3 Connect",
@@ -29,10 +29,14 @@ func newLitterRobotCmd(c *lrc.Client) *cobra.Command {
 		},
 	}
 
+	cmd.AddCommand(
+		newVersionCmd(version),
+	)
+
 	return cmd
 }
 
-func Execute() error {
+func Execute(v string) error {
 	var client *lrc.Client
-	return newLitterRobotCmd(client).Execute()
+	return newLitterRobotCmd(client, v).Execute()
 }

internal/cmd/version.go

@@ -0,0 +1,13 @@
+package cmd
+
+import "github.com/spf13/cobra"
+
+func newVersionCmd(version string) *cobra.Command {
+	return &cobra.Command{
+		Use:   "version",
+		Short: "print the version information",
+		Run: func(c *cobra.Command, _ []string) {
+			c.Println(version)
+		},
+	}
+}

main.go

@@ -1,9 +1,18 @@
 package main
 
 import (
+	"fmt"
+
 	"github.com/tlkamp/litterrobot/internal/cmd"
 )
 
+var (
+	version = "dev"
+	commit  = "none"
+	date    = "unknown"
+)
+
 func main() {
-	cmd.Execute() //nolint:errcheck
+	versionString := fmt.Sprintf("%s - %s - %s", version, commit, date)
+	cmd.Execute(versionString) //nolint:errcheck
 }