fix: implement automated version management and stabilize CI build process

realfishsam · realfishsam · commit 3d0c09e7d12a · 2026-01-17T11:16:39.000+02:00
This update introduces a unified versioning script and refactors the CI/CD workflows to ensure stable builds and consistent versions across core and SDK packages. It also adds a release management helper and local validation scripts.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -19,6 +19,16 @@ jobs:
         with:
           node-version: '20'
           registry-url: 'https://registry.npmjs.org'
+      
+      - name: Extract version from tag
+        id: get_version
+        run: |
+          VERSION=${GITHUB_REF#refs/tags/v}
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+          echo "Publishing version: $VERSION"
+      
+      - name: Update package versions
+        run: node update-versions.js ${{ steps.get_version.outputs.version }}
           
       - name: Install dependencies
         run: npm ci
@@ -63,6 +73,16 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: '3.x'
+      
+      - name: Extract version from tag
+        id: get_version
+        run: |
+          VERSION=${GITHUB_REF#refs/tags/v}
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+          echo "Publishing version: $VERSION"
+      
+      - name: Update package versions
+        run: node update-versions.js ${{ steps.get_version.outputs.version }}
           
       - name: Generate SDKs
         run: |
diff --git a/.github/workflows/test-publish.yml b/.github/workflows/test-publish.yml
@@ -23,6 +23,9 @@ jobs:
       - name: Install dependencies (Root)
         run: npm ci
 
+      - name: Simulate Version Update (Dry Run)
+        run: node update-versions.js 0.5.0-dryrun
+
       - name: Generate SDKs
         run: npm run generate:sdk:all --workspace=pmxt-core
 
@@ -67,9 +70,10 @@ jobs:
         with:
           node-version: '20'
 
-      - name: Install Node dependencies & Start Server
+      - name: Install Node dependencies & Start Server & Simulate Version
         run: |
           npm ci
+          node update-versions.js 0.5.0-dryrun
           npm run generate:sdk:all --workspace=pmxt-core
           npm run build --workspace=pmxt-core
           npm run server --workspace=pmxt-core &
diff --git a/core/package.json b/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "pmxt-core",
-  "version": "0.4.4",
+  "version": "0.5.0",
   "description": "pmxt is a unified prediction market data API. The ccxt for prediction markets.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -24,8 +24,8 @@
     "test": "jest -c jest.config.js",
     "server": "tsx watch src/server/index.ts",
     "server:prod": "node dist/server/index.js",
-    "generate:sdk:python": "npx @openapitools/openapi-generator-cli generate -i src/server/openapi.yaml -g python -o ../sdks/python/generated --package-name pmxt_internal --additional-properties=projectName=pmxt-internal,packageVersion=0.4.4,library=urllib3",
-    "generate:sdk:typescript": "npx @openapitools/openapi-generator-cli generate -i src/server/openapi.yaml -g typescript-fetch -o ../sdks/typescript/generated --additional-properties=npmName=pmxtjs,npmVersion=0.0.2,supportsES6=true,typescriptThreePlus=true",
+    "generate:sdk:python": "npx @openapitools/openapi-generator-cli generate -i src/server/openapi.yaml -g python -o ../sdks/python/generated --package-name pmxt_internal --additional-properties=projectName=pmxt-internal,packageVersion=0.5.0,library=urllib3",
+    "generate:sdk:typescript": "npx @openapitools/openapi-generator-cli generate -i src/server/openapi.yaml -g typescript-fetch -o ../sdks/typescript/generated --additional-properties=npmName=pmxtjs,npmVersion=0.5.0,supportsES6=true,typescriptThreePlus=true",
     "generate:sdk:all": "npm run generate:sdk:python && npm run generate:sdk:typescript"
   },
   "keywords": [],
@@ -52,4 +52,4 @@
     "ts-jest": "^29.4.6",
     "typescript": "^5.9.3"
   }
-}
+}
diff --git a/release.sh b/release.sh
@@ -0,0 +1,81 @@
+#!/bin/bash
+
+# Release script for PMXT
+# Usage: ./release.sh <version>
+# Example: ./release.sh 0.5.0
+
+set -e
+
+if [ -z "$1" ]; then
+    echo "[ERROR] Error: Version number required"
+    echo "Usage: ./release.sh <version>"
+    echo "Example: ./release.sh 0.5.0"
+    exit 1
+fi
+
+VERSION=$1
+
+# Validate version format (basic semver check)
+if ! [[ $VERSION =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+    echo "[ERROR] Error: Invalid version format. Use semantic versioning (e.g., 0.5.0)"
+    exit 1
+fi
+
+echo "[RELEASE] Preparing release v$VERSION"
+echo ""
+
+# Check if we're on the right branch
+CURRENT_BRANCH=$(git branch --show-current)
+echo "[INFO] Current branch: $CURRENT_BRANCH"
+
+# Check for uncommitted changes
+if ! git diff-index --quiet HEAD --; then
+    echo "[WARNING] Warning: You have uncommitted changes"
+    read -p "Continue anyway? (y/n) " -n 1 -r
+    echo
+    if [[ ! $REPLY =~ ^[Yy]$ ]]; then
+        exit 1
+    fi
+fi
+
+# Check if tag already exists
+if git rev-parse "v$VERSION" >/dev/null 2>&1; then
+    echo "[ERROR] Error: Tag v$VERSION already exists"
+    exit 1
+fi
+
+echo ""
+echo "[INFO] This will:"
+echo "   1. Create and push tag v$VERSION"
+echo "   2. Trigger GitHub Actions to:"
+echo "      - Auto-update all package versions to $VERSION"
+echo "      - Build and test all packages"
+echo "      - Publish pmxt-core@$VERSION to npm"
+echo "      - Publish pmxtjs@$VERSION to npm"
+echo "      - Publish pmxt@$VERSION to PyPI"
+echo ""
+
+read -p "Proceed with release? (y/n) " -n 1 -r
+echo
+if [[ ! $REPLY =~ ^[Yy]$ ]]; then
+    echo "[CANCEL] Release cancelled"
+    exit 1
+fi
+
+echo ""
+echo "[TAG] Creating tag v$VERSION..."
+git tag -a "v$VERSION" -m "Release v$VERSION"
+
+echo "[PUSH] Pushing tag to GitHub..."
+git push origin "v$VERSION"
+
+echo ""
+echo "[SUCCESS] Tag v$VERSION pushed successfully!"
+echo ""
+echo "[LINK] Monitor the release at:"
+echo "   https://github.com/qoery-com/pmxt/actions"
+echo ""
+echo "[INFO] Once published, packages will be available at:"
+echo "   - npm: https://www.npmjs.com/package/pmxt-core"
+echo "   - npm: https://www.npmjs.com/package/pmxtjs"
+echo "   - PyPI: https://pypi.org/project/pmxt/"
diff --git a/sdks/python/pyproject.toml b/sdks/python/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pmxt"
-version = "0.4.4"
+version = "0.5.0"
 description = "Unified prediction market data API - The ccxt for prediction markets"
 readme = "README.md"
 requires-python = ">=3.8"
diff --git a/sdks/typescript/package.json b/sdks/typescript/package.json
@@ -1,6 +1,6 @@
 {
   "name": "pmxtjs",
-  "version": "0.0.2",
+  "version": "0.5.0",
   "description": "Unified prediction market data API - The ccxt for prediction markets",
   "author": "PMXT Contributors",
   "repository": {
@@ -49,4 +49,4 @@
     "ts-jest": "^29.4.6",
     "typescript": "^5.0.0"
   }
-}
+}
diff --git a/test-publish-local.sh b/test-publish-local.sh
@@ -5,7 +5,7 @@
 
 set -e  # Exit on error
 
-echo "🧪 Starting local publish test..."
+echo "[TEST] Starting local publish test..."
 echo ""
 
 # Colors for output
@@ -23,25 +23,25 @@ rm -rf sdks/python/generated
 rm -rf sdks/python/dist
 rm -rf sdks/python/build
 rm -rf sdks/python/*.egg-info
-echo -e "${GREEN}✓ Clean complete${NC}"
+echo -e "${GREEN}[OK] Clean complete${NC}"
 echo ""
 
 # Step 2: Install dependencies
 echo -e "${BLUE}Step 2: Installing dependencies...${NC}"
 npm ci
-echo -e "${GREEN}✓ Dependencies installed${NC}"
+echo -e "${GREEN}[OK] Dependencies installed${NC}"
 echo ""
 
 # Step 3: Generate SDKs
 echo -e "${BLUE}Step 3: Generating SDKs...${NC}"
 npm run generate:sdk:all --workspace=pmxt-core
-echo -e "${GREEN}✓ SDKs generated${NC}"
+echo -e "${GREEN}[OK] SDKs generated${NC}"
 echo ""
 
 # Step 4: Build all workspaces
 echo -e "${BLUE}Step 4: Building all workspaces...${NC}"
 npm run build --workspaces
-echo -e "${GREEN}✓ All workspaces built${NC}"
+echo -e "${GREEN}[OK] All workspaces built${NC}"
 echo ""
 
 # Step 5: Start server and run tests
@@ -57,31 +57,31 @@ until curl -s http://localhost:3847/health > /dev/null 2>&1; do
     sleep 1
     ELAPSED=$((ELAPSED + 1))
     if [ $ELAPSED -ge $TIMEOUT ]; then
-        echo -e "${RED}✗ Server failed to start within ${TIMEOUT} seconds${NC}"
+        echo -e "${RED}[FAIL] Server failed to start within ${TIMEOUT} seconds${NC}"
         kill $SERVER_PID 2>/dev/null || true
         exit 1
     fi
 done
-echo -e "${GREEN}✓ Server is ready!${NC}"
+echo -e "${GREEN}[OK] Server is ready!${NC}"
 echo ""
 
 # Step 6: Run tests
 echo -e "${BLUE}Step 6: Running tests...${NC}"
 npm test --workspaces || {
-    echo -e "${RED}✗ Tests failed${NC}"
+    echo -e "${RED}[FAIL] Tests failed${NC}"
     kill $SERVER_PID 2>/dev/null || true
     exit 1
 }
-echo -e "${GREEN}✓ All tests passed${NC}"
+echo -e "${GREEN}[OK] All tests passed${NC}"
 echo ""
 
 # Step 7: Dry run publish
 echo -e "${BLUE}Step 7: Dry run publish (pmxt-core)...${NC}"
 npm publish --workspace=pmxt-core --dry-run 2>&1 | tee /tmp/pmxt-core-publish.log || {
     if grep -q "cannot publish over the previously published versions" /tmp/pmxt-core-publish.log; then
-        echo -e "${GREEN}✓ pmxt-core package is valid (version already published - expected)${NC}"
+        echo -e "${GREEN}[OK] pmxt-core package is valid (version already published - expected)${NC}"
     else
-        echo -e "${RED}✗ Dry run publish failed for pmxt-core${NC}"
+        echo -e "${RED}[FAIL] Dry run publish failed for pmxt-core${NC}"
         kill $SERVER_PID 2>/dev/null || true
         exit 1
     fi
@@ -91,9 +91,9 @@ echo ""
 echo -e "${BLUE}Step 8: Dry run publish (pmxtjs)...${NC}"
 npm publish --workspace=pmxtjs --dry-run 2>&1 | tee /tmp/pmxtjs-publish.log || {
     if grep -q "cannot publish over the previously published versions" /tmp/pmxtjs-publish.log; then
-        echo -e "${GREEN}✓ pmxtjs package is valid (version already published - expected)${NC}"
+        echo -e "${GREEN}[OK] pmxtjs package is valid (version already published - expected)${NC}"
     else
-        echo -e "${RED}✗ Dry run publish failed for pmxtjs${NC}"
+        echo -e "${RED}[FAIL] Dry run publish failed for pmxtjs${NC}"
         kill $SERVER_PID 2>/dev/null || true
         exit 1
     fi
@@ -111,31 +111,31 @@ pip install . > /dev/null 2>&1
 
 # Run Python tests
 pytest || {
-    echo -e "${RED}✗ Python tests failed${NC}"
+    echo -e "${RED}[FAIL] Python tests failed${NC}"
     kill $SERVER_PID 2>/dev/null || true
     exit 1
 }
-echo -e "${GREEN}✓ Python tests passed${NC}"
+echo -e "${GREEN}[OK] Python tests passed${NC}"
 echo ""
 
 # Build Python package
 echo -e "${BLUE}Step 10: Building Python package...${NC}"
 python3 -m build || {
-    echo -e "${RED}✗ Python build failed${NC}"
+    echo -e "${RED}[FAIL] Python build failed${NC}"
     kill $SERVER_PID 2>/dev/null || true
     exit 1
 }
-echo -e "${GREEN}✓ Python package built${NC}"
+echo -e "${GREEN}[OK] Python package built${NC}"
 echo ""
 
 # Verify package metadata
 echo -e "${BLUE}Step 11: Verifying Python package metadata...${NC}"
 twine check dist/* || {
-    echo -e "${RED}✗ Python package metadata verification failed${NC}"
+    echo -e "${RED}[FAIL] Python package metadata verification failed${NC}"
     kill $SERVER_PID 2>/dev/null || true
     exit 1
 }
-echo -e "${GREEN}✓ Python package metadata verified${NC}"
+echo -e "${GREEN}[OK] Python package metadata verified${NC}"
 echo ""
 
 cd ../..
@@ -145,7 +145,7 @@ kill $SERVER_PID 2>/dev/null || true
 
 echo ""
 echo -e "${GREEN}========================================${NC}"
-echo -e "${GREEN}✓ All tests passed successfully!${NC}"
+echo -e "${GREEN}[OK] All tests passed successfully!${NC}"
 echo -e "${GREEN}========================================${NC}"
 echo ""
 echo "You can now safely push to GitHub."
diff --git a/test-version-update.sh b/test-version-update.sh
@@ -0,0 +1,71 @@
+#!/bin/bash
+
+# Test script to verify version update logic works correctly
+# This simulates what the GitHub Actions workflow will do
+
+set -e
+
+echo "[TEST] Testing version update logic..."
+echo ""
+
+# Simulate a version
+TEST_VERSION="0.5.0"
+echo "Test version: $TEST_VERSION"
+echo ""
+
+# Create temporary copies of package files
+cp core/package.json /tmp/test-core-package.json
+cp sdks/typescript/package.json /tmp/test-ts-package.json
+cp sdks/python/pyproject.toml /tmp/test-pyproject.toml
+
+echo "[DEBUG] Testing sed commands..."
+echo ""
+
+# Test core package.json update
+sed -i.bak "s/\"version\": \".*\"/\"version\": \"$TEST_VERSION\"/" /tmp/test-core-package.json
+CORE_VERSION=$(grep '"version":' /tmp/test-core-package.json | head -1 | sed 's/.*"version": "\(.*\)".*/\1/')
+echo "[OK] core/package.json version: $CORE_VERSION"
+
+# Test TypeScript SDK package.json update
+sed -i.bak "s/\"version\": \".*\"/\"version\": \"$TEST_VERSION\"/" /tmp/test-ts-package.json
+TS_VERSION=$(grep '"version":' /tmp/test-ts-package.json | head -1 | sed 's/.*"version": "\(.*\)".*/\1/')
+echo "[OK] sdks/typescript/package.json version: $TS_VERSION"
+
+# Test Python pyproject.toml update
+sed -i.bak "s/^version = \".*\"/version = \"$TEST_VERSION\"/" /tmp/test-pyproject.toml
+PY_VERSION=$(grep '^version = ' /tmp/test-pyproject.toml | sed 's/version = "\(.*\)"/\1/')
+echo "[OK] sdks/python/pyproject.toml version: $PY_VERSION"
+
+# Test generator command updates
+sed -i.bak "s/packageVersion=[0-9.]\+/packageVersion=$TEST_VERSION/" /tmp/test-core-package.json
+GENERATOR_VERSION=$(grep 'packageVersion=' /tmp/test-core-package.json | sed 's/.*packageVersion=\([0-9.]\+\).*/\1/')
+echo "[OK] Python generator packageVersion: $GENERATOR_VERSION"
+
+sed -i.bak "s/npmVersion=[0-9.]\+/npmVersion=$TEST_VERSION/" /tmp/test-core-package.json
+NPM_VERSION=$(grep 'npmVersion=' /tmp/test-core-package.json | sed 's/.*npmVersion=\([0-9.]\+\).*/\1/')
+echo "[OK] TypeScript generator npmVersion: $NPM_VERSION"
+
+echo ""
+
+# Verify all versions match
+if [ "$CORE_VERSION" = "$TEST_VERSION" ] && \
+   [ "$TS_VERSION" = "$TEST_VERSION" ] && \
+   [ "$PY_VERSION" = "$TEST_VERSION" ] && \
+   [ "$GENERATOR_VERSION" = "$TEST_VERSION" ] && \
+   [ "$NPM_VERSION" = "$TEST_VERSION" ]; then
+    echo "[SUCCESS] All version updates successful!"
+    echo ""
+    echo "The workflow will correctly update versions from git tags."
+else
+    echo "[ERROR] Version mismatch detected!"
+    echo "Expected: $TEST_VERSION"
+    echo "Core: $CORE_VERSION"
+    echo "TS: $TS_VERSION"
+    echo "Python: $PY_VERSION"
+    echo "Generator (Python): $GENERATOR_VERSION"
+    echo "Generator (TS): $NPM_VERSION"
+    exit 1
+fi
+
+# Cleanup
+rm /tmp/test-*.json /tmp/test-*.toml /tmp/test-*.bak 2>/dev/null || true
diff --git a/update-versions.js b/update-versions.js

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "pmxtjs",`
`3`		`- "version": "0.0.2",`
	`3`	`+ "version": "0.5.0",`
`4`	`4`	`"description": "Unified prediction market data API - The ccxt for prediction markets",`
`5`	`5`	`"author": "PMXT Contributors",`
`6`	`6`	`"repository": {`
`@@ -49,4 +49,4 @@`
`49`	`49`	`"ts-jest": "^29.4.6",`
`50`	`50`	`"typescript": "^5.0.0"`
`51`	`51`	`}`
`52`		`-}`
	`52`	`+}`