Simplify CI version checking

- Make version check informational only for PRs - Add ability to skip check with [skip-version-check] in commit message - Remove complex logic in favor of simpler workflow - Ensure developers retain control over versioning
coder · matifali · Apr 22, 2025 · Apr 10, 2025 · Apr 10, 2025 · Apr 10, 2025
commit c6cffc802a88fcd10768f860a1d81f887f38213a
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -54,60 +54,20 @@ jobs:
       - name: Check module versions
         shell: bash
         run: |
-          # For PRs: Check that modules with changes have their README versions updated
-          # For merged commits: Check that versions match tags
-
-          # First, identify which modules have changes
-          echo "Identifying modules with changes..."
-          CHANGED_MODULES=$(./modules-version.sh | grep "Module " | cut -d: -f1 | sed 's/Module //')
-
+          # Add ability to skip version check with a marker in commit message
+          if [[ "${{ contains(github.event.head_commit.message || '', '[skip-version-check]') }}" == "true" ]]; then
+            echo "Version check skipped by commit message"
+            exit 0
+          fi
+
+          # For PRs, just check that the version in README matches what's in modules-version.sh
+          # This assumes developer has run the script locally to update versions
+          echo "Checking module versions for changed modules..."
+          ./modules-version.sh
+
+          # Skip actual checks when in PR
           if [ "${{ github.event_name }}" == "pull_request" ]; then
-            echo "Pull request detected - checking if versions need updating..."
-
-            # Extract the base branch (usually main)
-            BASE_BRANCH="${{ github.base_ref }}"
-            echo "Base branch: $BASE_BRANCH"
-
-            # For each changed module, check if the version in README.md has been incremented
-            # compared to the latest tag for that module
-            EXIT_CODE=0
-            for module in $CHANGED_MODULES; do
-              echo "Checking module: $module"
-
-              # Skip modules without tags
-              if ! git tag -l "release/$module/v*" | grep -q .; then
-                echo "Module $module has no previous tags, skipping version check"
-                continue
-              fi
-
-              # Get latest tag version for this module
-              LATEST_TAG=$(git tag -l "release/$module/v*" | sort -V | tail -n 1)
-              TAG_VERSION=$(echo "$LATEST_TAG" | sed "s|release/$module/v||")
-
-              # Extract version from README.md in the PR
-              README_VERSION=$(grep -o 'version *= *"[0-9]\+\.[0-9]\+\.[0-9]\+"' "$module/README.md" | head -1 | grep -o '[0-9]\+\.[0-9]\+\.[0-9]\+' || echo "0.0.0")
-
-              echo "Module $module - Latest tag: $TAG_VERSION, PR version: $README_VERSION"
-
-              # Compare versions using simple numeric comparison (assumes semantic versioning)
-              TAG_VERSION_NUM=$(echo "$TAG_VERSION" | sed 's/\.//g')
-              README_VERSION_NUM=$(echo "$README_VERSION" | sed 's/\.//g')
-
-              if [ "$README_VERSION_NUM" -le "$TAG_VERSION_NUM" ]; then
-                echo "ERROR: Version in $module/README.md ($README_VERSION) must be greater than the latest tag ($TAG_VERSION)"
-                echo "Please update the version in $module/README.md using one of these methods:"
-                echo "  - Run: ./modules-version.sh --bump=patch $module"
-                echo "  - Run: ./modules-version.sh --bump=minor $module"
-                echo "  - Run: ./modules-version.sh --bump=major $module"
-                EXIT_CODE=1
-              else
-                echo "✓ Version in $module/README.md has been properly incremented"
-              fi
-            done
-
-            exit $EXIT_CODE
-          else
-            # For pushes to main, run the regular check to ensure versions match tags
-            echo "Push to branch detected - checking versions match tags..."
-            ./modules-version.sh --check
+            echo "Pull request detected - version check is informational only"
+            echo "Remember to update versions with ./modules-version.sh if needed"
+            exit 0
           fi