chore: add versioning mechanism (#4)

amir78729 · web-flow · commit 3a3215769d38 · 2026-01-31T17:13:01.000+03:30
diff --git a/.github/workflows/development.yml b/.github/workflows/development.yml
@@ -13,8 +13,8 @@ permissions:
   pull-requests: write
 
 jobs:
-  test:
-    name: "Unit Tests"
+  check:
+    name: "All Checks"
     runs-on: ubuntu-latest
     timeout-minutes: 10
     steps:
@@ -30,48 +30,5 @@ jobs:
       - name: "📦 Download dependencies"
         run: go mod download
 
-      - name: "🔍 Run tests with coverage"
-        run: make test-cover
-
-  lint:
-    name: "Lint Code"
-    runs-on: ubuntu-latest
-    timeout-minutes: 10
-    steps:
-      - name: "☁️ Checkout repository"
-        uses: actions/checkout@v4
-
-      - name: "🔧 Setup Go"
-        uses: actions/setup-go@v5
-        with:
-          go-version: '1.25'
-          cache: true
-
-      - name: "📦 Download dependencies"
-        run: go mod download
-
-      - name: "🔍 Check code formatting"
-        run: make fmt-check
-
-      - name: "🔍 Run linter"
-        run: make lint
-
-  build:
-    name: "Build Check"
-    runs-on: ubuntu-latest
-    timeout-minutes: 10
-    steps:
-      - name: "☁️ Checkout repository"
-        uses: actions/checkout@v4
-
-      - name: "🔧 Setup Go"
-        uses: actions/setup-go@v5
-        with:
-          go-version: '1.25'
-          cache: true
-
-      - name: "📦 Download dependencies"
-        run: go mod download
-
-      - name: "🔨 Build all packages"
-        run: make build
+      - name: "🔍 Run all checks"
+        run: make check
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -18,37 +18,54 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: "🔍 Extract version from branch name"
-        id: extract-version
-        run: ./scripts/extract-version.sh "${{ github.event.pull_request.head.ref }}"
+      - name: "🔍 Check if version changed"
+        id: version-check
+        run: |
+          if [ ! -f .versionrc ]; then
+            echo "version_changed=false" >> $GITHUB_OUTPUT
+            echo "❌ .versionrc file not found"
+            exit 0
+          fi
+          
+          VERSION=$(cat .versionrc | tr -d '[:space:]')
+          echo "current_version=$VERSION" >> $GITHUB_OUTPUT
+          
+          # Check if this version tag already exists
+          if git tag | grep -q "^v$VERSION$"; then
+            echo "version_changed=false" >> $GITHUB_OUTPUT
+            echo "❌ Version v$VERSION already exists"
+          else
+            echo "version_changed=true" >> $GITHUB_OUTPUT
+            echo "✅ New version detected: v$VERSION"
+          fi
 
       - name: "🔧 Setup Go"
-        if: steps.extract-version.outputs.should_release == 'true'
+        if: steps.version-check.outputs.version_changed == 'true'
         uses: actions/setup-go@v5
         with:
           go-version: '1.25'
           cache: true
 
       - name: "📦 Download dependencies"
-        if: steps.extract-version.outputs.should_release == 'true'
+        if: steps.version-check.outputs.version_changed == 'true'
         run: go mod download
 
       - name: "🔍 Run tests before release"
-        if: steps.extract-version.outputs.should_release == 'true'
+        if: steps.version-check.outputs.version_changed == 'true'
         run: make test-cover
 
       - name: "🏷️ Create and push tag"
-        if: steps.extract-version.outputs.should_release == 'true'
+        if: steps.version-check.outputs.version_changed == 'true'
         run: |
-          VERSION="${{ steps.extract-version.outputs.version }}"
+          VERSION="v${{ steps.version-check.outputs.current_version }}"
           git config user.name "github-actions[bot]"
           git config user.email "github-actions[bot]@users.noreply.github.com"
           git tag -a "$VERSION" -m "Release $VERSION"
           git push origin "$VERSION"
           echo "Created and pushed tag: $VERSION"
 
       - name: "🚀 Run GoReleaser"
-        if: steps.extract-version.outputs.should_release == 'true'
+        if: steps.version-check.outputs.version_changed == 'true'
         uses: goreleaser/goreleaser-action@v6
         with:
           distribution: goreleaser
diff --git a/.versionrc b/.versionrc
@@ -0,0 +1 @@
+0.0.1
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -231,3 +231,60 @@ and `go vet` for static analysis. Follow standard Go conventions:
 By contributing your code to the `Tap30/*` GitHub repositories, you agree to
 license your contribution under the
 [MIT license](https://github.com/Tap30/ripple-go/blob/main/LICENSE).
+## Release Process
+
+### Versioning
+
+This project uses a `.versionrc` file to manage versions. The version format follows [Semantic Versioning](https://semver.org/).
+
+#### Making a Release
+
+1. **Create a new branch** for the version update:
+   ```bash
+   git checkout -b release/1.2.3
+   ```
+
+2. **Update the version** in `.versionrc`:
+   ```bash
+   echo "1.2.3" > .versionrc
+   ```
+
+3. **Sync the version** to Go code:
+   ```bash
+   make version-sync
+   ```
+
+4. **Verify version consistency**:
+   ```bash
+   make version-check
+   ```
+
+5. **Commit and push** the changes:
+   ```bash
+   git add .versionrc version.go
+   git commit -m "chore: bump version to 1.2.3"
+   git push origin release/1.2.3
+   ```
+
+6. **Create a Pull Request** to main branch
+
+7. **Merge the PR**: GitHub Actions will automatically create a release tag and GitHub release when the PR is merged to main (only if `.versionrc` contains a new version).
+
+#### Version Guidelines
+
+- **Patch** (x.x.X): Bug fixes, documentation updates
+- **Minor** (x.X.x): New features, backward compatible changes  
+- **Major** (X.x.x): Breaking changes, API changes
+
+#### Development Commands
+
+```bash
+# Sync version from .versionrc to version.go
+make version-sync
+
+# Check if versions are consistent
+make version-check
+
+# Test release configuration
+make release-test
+```
diff --git a/Makefile b/Makefile
@@ -34,10 +34,28 @@ build:
 	$(GO) build ./...
 
 # CI checks (same as GitHub Actions)
-check: fmt-check lint test build
+check: fmt-check lint test build version-check
 	@echo "All checks passed!"
 
 # Release management
+version-sync:
+	@echo "Syncing version between .versionrc and version.go..."
+	./scripts/sync-version.sh
+
+version-check:
+	@echo "Checking version consistency..."
+	@VERSION_RC=$$(cat .versionrc | tr -d '[:space:]'); \
+	VERSION_GO=$$(grep 'const Version' version.go | sed 's/.*"\(.*\)".*/\1/'); \
+	if [ "$$VERSION_RC" != "$$VERSION_GO" ]; then \
+		echo "❌ Version mismatch:"; \
+		echo "  .versionrc: $$VERSION_RC"; \
+		echo "  version.go: $$VERSION_GO"; \
+		echo "Run 'make version-sync' to fix"; \
+		exit 1; \
+	else \
+		echo "✅ Version consistent: $$VERSION_RC"; \
+	fi
+
 release-test:
 	@echo "Testing release configuration..."
 	goreleaser check
@@ -76,10 +94,14 @@ help:
 	@echo "Building:"
 	@echo "  make build        - Build all packages"
 	@echo ""
+	@echo "Release Management:"
+	@echo "  make version-sync   - Sync version from .versionrc to version.go"
+	@echo "  make version-check  - Check version consistency"
+	@echo "  make release-test   - Test release configuration"
+	@echo "  make release        - Create actual release"
+	@echo ""
 	@echo "CI/CD:"
-	@echo "  make check        - Run all CI checks (fmt, lint, test, build)"
-	@echo "  make release-test - Test release configuration"
-	@echo "  make release      - Create actual release"
+	@echo "  make check        - Run all CI checks (fmt, lint, test, build, version)"
 	@echo ""
 	@echo "Development:"
 	@echo "  make dev-deps     - Install development dependencies"
diff --git a/README.md b/README.md
@@ -32,7 +32,13 @@ for browsers.
 ## Installation
 
 ```bash
-go get github.com/Tap30/ripple-go
+go get github.com/Tap30/ripple-go@latest
+```
+
+Or install a specific version:
+
+```bash
+go get github.com/Tap30/ripple-go@v0.0.1
 ```
 
 ## Quick Start
diff --git a/scripts/README.md b/scripts/README.md
@@ -0,0 +1,22 @@
+# Scripts
+
+## sync-version.sh
+
+Synchronizes the version from `.versionrc` to `version.go`.
+
+**Usage:**
+```bash
+./scripts/sync-version.sh
+```
+
+**What it does:**
+1. Reads version from `.versionrc`
+2. Validates semantic version format (x.x.x or x.x.x-suffix)
+3. Updates `version.go` with the new version constant
+4. Reports the changes
+
+**Makefile integration:**
+```bash
+make version-sync    # Run the sync script
+make version-check   # Verify versions are consistent
+```
diff --git a/scripts/extract-version.sh b/scripts/extract-version.sh
diff --git a/scripts/sync-version.sh b/scripts/sync-version.sh
@@ -0,0 +1,38 @@
+#!/bin/bash
+
+# Sync version between .versionrc and version.go
+# Usage: ./scripts/sync-version.sh
+
+set -e
+
+if [ ! -f .versionrc ]; then
+    echo "❌ .versionrc file not found"
+    exit 1
+fi
+
+VERSION=$(cat .versionrc | tr -d '[:space:]')
+
+if [ -z "$VERSION" ]; then
+    echo "❌ Version is empty in .versionrc"
+    exit 1
+fi
+
+# Validate semantic version format
+if ! [[ $VERSION =~ ^[0-9]+\.[0-9]+\.[0-9]+(-[a-zA-Z0-9]+)?$ ]]; then
+    echo "❌ Invalid version format: $VERSION"
+    echo "Expected format: x.x.x or x.x.x-suffix"
+    exit 1
+fi
+
+# Update version.go
+cat > version.go << EOF
+package ripple
+
+// Version represents the current version of the Ripple Go SDK
+const Version = "$VERSION"
+EOF
+
+echo "✅ Version synced: $VERSION"
+echo "Updated files:"
+echo "  - .versionrc: $VERSION"
+echo "  - version.go: const Version = \"$VERSION\""
diff --git a/version.go b/version.go
@@ -0,0 +1,4 @@
+package ripple
+
+// Version represents the current version of the Ripple Go SDK
+const Version = "0.0.1"
