Refactor/version migrate to file based versioning (#6)

* Added version.txt and corresponding handler. And fixed relative path issue caused by the change

* Added workflow for static version model.

* Fixed version handling in the Makefile.

* versioning and tagging workflow docs added

.github/workflows/tag-version.yml

@@ -0,0 +1,29 @@
+name: Tag on Version Change
+
+on:
+  push:
+    branches:
+      - master  
+    paths:
+      - "version/version.txt"  
+
+jobs:
+  create_tag:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the code
+        uses: actions/checkout@v4
+
+      - name: Read version from version.txt
+        id: read_version
+        run: |
+          VERSION=$(cat version/version.txt)
+          echo "VERSION=$VERSION" >> $GITHUB_ENV
+
+      - name: Create and push tag
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git tag -a "v${{ env.VERSION }}" -m "Release version ${{ env.VERSION }}"
+          git push origin "v${{ env.VERSION }}"

.goreleaser.yml

@@ -10,7 +10,7 @@ builds:
       - amd64
       - arm64
     ldflags: 
-      - -s -w -X bbox/version.version={{.Version}} -X bbox/version.commit={{.Commit}} -X bbox/version.date={{.Date}} -X bbox/version.builtBy=goreleaser
+      - -s -w 
 
 archives:
   - format: tar.gz

CONTRIBUTING.md

@@ -9,10 +9,11 @@ Thank you for your interest in contributing to BBOX! We appreciate your efforts
 3. [How to Suggest Documentation Improvements](#how-to-suggest-documentation-improvements)
 4. [How to Submit a Pull Request](#how-to-submit-a-pull-request)
 5. [Branch Naming Convention](#branch-naming-convention)
-6. [Style Guide](#style-guide)
-7. [Testing](#testing)
-8. [Documentation](#documentation)
-9. [Communication](#communication)
+6. [Versioning and Tagging Workflow](#versioning-and-tagging-workflow)
+7. [Style Guide](#style-guide)
+8. [Testing](#testing)
+9. [Documentation](#documentation)
+10. [Communication](#communication)
 
 ## How to Report a Bug
 
@@ -71,6 +72,53 @@ For example:
 feat/clean_add-new-clean-feature
 ```
 
+## Versioning and Tagging Workflow
+
+BBOX uses a versioning and tagging system to manage releases, following semantic versioning principles. Here’s how the process works:
+
+### Semantic Versioning
+
+The version number in `version/version.txt` follows semantic versioning:
+
+- **MAJOR** version (`v1.0.0`) is incremented when you make incompatible API changes.
+- **MINOR** version (`v1.1.0`) is incremented when you add functionality in a backward-compatible manner.
+- **PATCH** version (`v1.1.1`) is incremented when you make backward-compatible bug fixes.
+- Additional labels for pre-release and build metadata (e.g., `v1.1.0-rc1`) are available as extensions to the MAJOR.MINOR.PATCH format.
+
+### Versioning Workflow
+
+1. **Updating the Version**:
+   - Before submitting a Pull Request (PR), update the `version.txt` file with the new version number based on the changes you are introducing (e.g., `v1.1.0` or `v1.1.0-rc1` for release candidates).
+
+2. **Committing the Version Change**:
+   - Commit the change to `version.txt` with a descriptive commit message following our convention.
+   - For example: `release/version_Update-to-v1.1.0`.
+
+3. **Submit a Pull Request**:
+   - Once the version update is ready, submit your PR for review. The version change will only take effect after the PR is approved and merged into the `master` branch.
+
+4. **Automatic Tagging**:
+   - When the change to `version.txt` is merged into the `master` branch, a GitHub Actions workflow automatically creates a new Git tag based on the version number in `version.txt`.
+   - The tag will follow the format:
+     - `v*.*.*` for regular releases (e.g., `v1.1.0`).
+     - `v*.*.*-rc*` for release candidates (e.g., `v1.1.0-rc1`).
+
+5. **Release Process**:
+   - The creation of the tag will trigger a separate GitHub Actions workflow that runs GoReleaser to build and publish the release.
+   - This process will include:
+     - **Building and publishing binaries**.
+     - **Creating a new Docker image and pushing it to DockerHub**.
+
+### Example Workflow:
+
+1. Update `version.txt` with the new version number (e.g., `v1.1.0` or `v1.1.0-rc1`).
+2. Commit the change: `git commit -m "chore/version_Update-to-v1.1.0"`.
+3. Submit a PR for review.
+4. After the PR is approved and merged into `master`, the tagging workflow will automatically create a new tag (e.g., `v1.1.0`).
+5. The release workflow will then:
+   - Build and publish the new version using GoReleaser.
+   - Create and push a new Docker image to DockerHub.
+
 ## Style Guide
 
 Please adhere to the following coding standards:

cmd/version.go

@@ -4,9 +4,8 @@ Copyright © 2024 NAME HERE <EMAIL ADDRESS>
 package cmd
 
 import (
-	"fmt"
-
 	"bbox/version"
+	"fmt"
 
 	"github.com/spf13/cobra"
 )
@@ -20,6 +19,6 @@ var versionCmd = &cobra.Command{
 	Use:   "version",
 	Short: "Print the version number of bbox",
 	Run: func(cmd *cobra.Command, args []string) {
-		fmt.Println("bbox version:", version.GetFormattedVersion())
+		fmt.Println("bbox version:", version.GetVersion())
 	},
 }

makefile

@@ -1,7 +1,8 @@
+.PHONY: test lint help version
+
 NAME ?= bbox
 GOCMD=go
 GOTEST=$(GOCMD) test
-VERSION := $(shell $(GOCMD) run main.go)
 
 test:  ## Run tests for the project
 		$(GOTEST) ./... -v
@@ -12,3 +13,6 @@ lint: ## Run linter
 help: ## Show Help menu
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
+version: ## Show bbox current version
+	$(GOCMD) run bbox version
+

pkg/utils/file_test.go

@@ -1,7 +1,6 @@
 package utils_test
 
 import (
-	"io/ioutil"
 	"os"
 	"path/filepath"
 	"testing"
@@ -16,7 +15,7 @@ func TestUnzipFile(t *testing.T) {
 	destDir := "/tmp"
 
 	// Create a temporary directory for testing
-	tempDir, err := ioutil.TempDir("", "unzip_test")
+	tempDir, err := os.MkdirTemp("", "unzip_test")
 	assert.NoError(t, err)
 	defer os.RemoveAll(tempDir)
 

teamcity/queue.go

@@ -3,7 +3,6 @@ package teamcity
 import (
 	"fmt"
 	"io"
-	"io/ioutil"
 	"net/http"
 
 	log "github.com/sirupsen/logrus"
@@ -31,7 +30,7 @@ func (qs *QueueService) ClearQueue() error {
 
 	// Check the response. Expecting HTTP Status No Content (204) or OK (200) as a success indicator.
 	if response.StatusCode != http.StatusOK && response.StatusCode != http.StatusNoContent {
-		bodyBytes, _ := ioutil.ReadAll(response.Body)
+		bodyBytes, _ := io.ReadAll(response.Body)
 		return fmt.Errorf("failed to clear the queue, status code: %d, response: %s", response.StatusCode, string(bodyBytes))
 	}
 

version/handler.go

@@ -0,0 +1,27 @@
+package version
+
+import (
+	"embed"
+	"log"
+	"strings"
+)
+
+var (
+	// Version is loaded from version.txt file
+	version = loadVersionFromFile()
+
+	//go:embed version.txt
+	embedFS embed.FS
+)
+
+func GetVersion() string {
+	return version
+}
+
+func loadVersionFromFile() string {
+	data, err := embedFS.ReadFile("version.txt")
+	if err != nil {
+		log.Fatalf("Failed to read version file: %v", err)
+	}
+	return strings.TrimSpace(string(data))
+}

version/version.txt

@@ -0,0 +1 @@
+v1.0.0-rc