Add version tagging

Author: chand1012

Justfile

@@ -1,11 +1,16 @@
+DATE := `date +"%Y-%m-%d_%H:%M:%S"`
+GIT_COMMIT := `git rev-parse HEAD`
+VERSION_TAG := `git describe --tags --abbrev=0`
+LD_FLAGS := "-X github.com/chand1012/ottodocs/cmd.buildDate=" + DATE + " -X github.com/chand1012/ottodocs/cmd.commitHash=" + GIT_COMMIT + " -X github.com/chand1012/ottodocs/cmd.tag=" + VERSION_TAG
+
 default:
   just --list --unsorted
 
 tidy:
   go mod tidy
 
 build:
-  go build -v -o bin/otto
+  go build -ldflags "{{LD_FLAGS}}" -v -o bin/otto
 
 clean:
   rm -rf bin dist
@@ -18,6 +23,7 @@ cobra-docs:
   go run docs/gen_docs.go
 
 install: build
+  rm -rf $GOPATH/bin/otto
   cp bin/otto $GOPATH/bin
 
 crossbuild:
@@ -31,35 +37,35 @@ crossbuild:
 
   # Build for M1 Mac (Apple Silicon)
   echo "Building for M1 Mac (Apple Silicon)"
-  env GOOS=darwin GOARCH=arm64 go build -o "${BINARY_NAME}" "${GO_PACKAGE}"
+  env GOOS=darwin GOARCH=arm64 go build -ldflags "{{LD_FLAGS}}" -o "${BINARY_NAME}" "${GO_PACKAGE}"
   zip "${BINARY_NAME}_darwin_arm64.zip" "${BINARY_NAME}"
   rm "${BINARY_NAME}"
   mv "${BINARY_NAME}_darwin_arm64.zip" dist/
 
   # Build for AMD64 Mac (Intel)
   echo "Building for AMD64 Mac (Intel)"
-  env GOOS=darwin GOARCH=amd64 go build -o "${BINARY_NAME}" "${GO_PACKAGE}"
+  env GOOS=darwin GOARCH=amd64 go build -ldflags "{{LD_FLAGS}}" -o "${BINARY_NAME}" "${GO_PACKAGE}"
   zip "${BINARY_NAME}_darwin_amd64.zip" "${BINARY_NAME}"
   rm "${BINARY_NAME}"
   mv "${BINARY_NAME}_darwin_amd64.zip" dist/
 
   # Build for AMD64 Windows
   echo "Building for AMD64 Windows"
-  env GOOS=windows GOARCH=amd64 go build -o "${BINARY_NAME}.exe" "${GO_PACKAGE}"
+  env GOOS=windows GOARCH=amd64 go build -ldflags "{{LD_FLAGS}}" -o "${BINARY_NAME}.exe" "${GO_PACKAGE}"
   zip "${BINARY_NAME}_windows_amd64.zip" "${BINARY_NAME}.exe"
   rm "${BINARY_NAME}.exe"
   mv "${BINARY_NAME}_windows_amd64.zip" dist/
 
   # Build for AMD64 Linux
   echo "Building for AMD64 Linux"
-  env GOOS=linux GOARCH=amd64 go build -o "${BINARY_NAME}" "${GO_PACKAGE}"
+  env GOOS=linux GOARCH=amd64 go build -ldflags "{{LD_FLAGS}}" -o "${BINARY_NAME}" "${GO_PACKAGE}"
   tar czvf "${BINARY_NAME}_linux_amd64.tar.gz" "${BINARY_NAME}"
   rm "${BINARY_NAME}"
   mv "${BINARY_NAME}_linux_amd64.tar.gz" dist/
 
   # Build for ARM64 Linux
   echo "Building for ARM64 Linux"
-  env GOOS=linux GOARCH=arm64 go build -o "${BINARY_NAME}" "${GO_PACKAGE}"
+  env GOOS=linux GOARCH=arm64 go build -ldflags "{{LD_FLAGS}}" -o "${BINARY_NAME}" "${GO_PACKAGE}"
   tar czvf "${BINARY_NAME}_linux_arm64.tar.gz" "${BINARY_NAME}"
   rm "${BINARY_NAME}"
   mv "${BINARY_NAME}_linux_arm64.tar.gz" dist/

README.md

@@ -2,7 +2,7 @@
 
 [![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
 
-OttoDocs is a command-line tool written in Go that uses GPT-3 (and GPT-4 once the API is available) to automatically generate or add inline and markdown documentation for your code. It can parse a git repository or an individual file and create markdown documentation or add inline comments. The tool requires an [OpenAI API key](https://platform.openai.com/account/api-keys) to function.
+OttoDocs is a command-line tool written in Go that uses ChatGPT to automatically generate or add inline and markdown documentation for your code. It can parse a git repository or an individual file and create markdown documentation or add inline comments. The tool requires an [OpenAI API key](https://platform.openai.com/account/api-keys) to function.
 
 OttoDocs utilizes the `just` command runner for building and running tasks, making maintaining the project easier. If you do not have `just` installed, see [here](https://just.systems/man/en/chapter_5.html) for installation methods.
 

cmd/version.go

@@ -0,0 +1,32 @@
+/*
+Copyright © 2023 NAME HERE <EMAIL ADDRESS>
+*/
+package cmd
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/spf13/cobra"
+)
+
+var commitHash string
+var buildDate string
+var tag string
+
+// versionCmd represents the version command
+var versionCmd = &cobra.Command{
+	Use:   "version",
+	Short: "Prints version information.",
+	Long:  `Prints version information.`,
+	Run: func(cmd *cobra.Command, args []string) {
+		fmt.Println("ottodocs")
+		fmt.Println("commit hash:", commitHash)
+		fmt.Println("build date:", strings.ReplaceAll(buildDate, "_", " "))
+		fmt.Println("version:", tag)
+	},
+}
+
+func init() {
+	RootCmd.AddCommand(versionCmd)
+}

docs/otto.md

@@ -17,9 +17,11 @@ Code documentation made easy using GPT.
 * [otto ask](otto_ask.md)	 - Ask a question about a file or repo
 * [otto chat](otto_chat.md)	 - Ask ChatGPT a question from the command line.
 * [otto cmd](otto_cmd.md)	 - Have ChatGPT suggest a command to run next
+* [otto commit](otto_commit.md)	 - Generates a commit message from the git diff
 * [otto docs](otto_docs.md)	 - Document a repository of files or a single file
 * [otto login](otto_login.md)	 - Add an API key to your configuration
 * [otto prompt](otto_prompt.md)	 - Generates a ChatGPT prompt from a given Git repo
 * [otto setModel](otto_setModel.md)	 - Set the model to use for documentation
+* [otto version](otto_version.md)	 - Prints version information.
 
 ###### Auto generated by spf13/cobra on 21-Apr-2023

docs/otto_commit.md

@@ -0,0 +1,25 @@
+## otto commit
+
+Generates a commit message from the git diff
+
+### Synopsis
+
+Uses the git diff to generate a commit message. Requires Git to be installed on the system.
+
+```
+otto commit [flags]
+```
+
+### Options
+
+```
+  -c, --conventional   use conventional commits
+  -h, --help           help for commit
+  -p, --plain          no output formatting
+```
+
+### SEE ALSO
+
+* [otto](otto.md)	 - Document your code with ease
+
+###### Auto generated by spf13/cobra on 21-Apr-2023

docs/otto_version.md

@@ -0,0 +1,23 @@
+## otto version
+
+Prints version information.
+
+### Synopsis
+
+Prints version information.
+
+```
+otto version [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for version
+```
+
+### SEE ALSO
+
+* [otto](otto.md)	 - Document your code with ease
+
+###### Auto generated by spf13/cobra on 21-Apr-2023