CCM-11027: enforce correct versioning of event schemas (#624)

Co-authored-by: Chris Elliott <[email protected]>

Author: harrim91

.github/workflows/pr_closed.yaml

@@ -78,8 +78,12 @@ jobs:
       - name: check if local version differs from latest published version
         id: check-version
         run: |
-          published_version=$(npm view @nhsdigital/nhs-notify-event-schemas-template-management --json 2>/dev/null | jq -r '.["dist-tags"].latest')
-          local_version=$(cat packages/event-schemas/package.json | jq -r '.version')
+          published_version=$(npm view @nhsdigital/nhs-notify-event-schemas-template-management --json 2>/dev/null | jq -r '.["dist-tags"].latest // "null"')
+          echo "Published version: $published_version"
+
+          local_version=$(jq -r '.version' packages/event-schemas/package.json)
+          echo "Local version: $local_version"
+
           if [[ $local_version = $published_version ]]; then
             echo "Local version is the same as the latest published version - skipping publish"
             echo "version_changed=false" >> $GITHUB_OUTPUT

.github/workflows/stage-1-commit.yaml

@@ -199,3 +199,86 @@ jobs:
           idp_aws_report_upload_region: "${{ secrets.IDP_AWS_REPORT_UPLOAD_REGION }}"
           idp_aws_report_upload_role_name: "${{ secrets.IDP_AWS_REPORT_UPLOAD_ROLE_NAME }}"
           idp_aws_report_upload_bucket_endpoint: "${{ secrets.IDP_AWS_REPORT_UPLOAD_BUCKET_ENDPOINT }}"
+
+  detect-event-schema-package-changes:
+    name: "Check for changes to event schema package compared to main branch"
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    outputs:
+      changed: ${{ steps.check.outputs.changed }}
+      main_version: ${{ steps.check.outputs.main_version }}
+
+    steps:
+      - name: "Checkout code"
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Detect package changes and current version
+        id: check
+        run: |
+          git fetch origin main
+
+          if git diff --quiet origin/main...HEAD -- packages/event-schemas; then
+            echo "No changes in event schemas package"
+            echo "changed=false" >> $GITHUB_OUTPUT
+          else
+            echo "Changes detected in event schemas"
+            echo "changed=true" >> $GITHUB_OUTPUT
+          fi
+
+          if content=$(git show origin/main:packages/event-schemas/package.json 2>/dev/null); then
+            version=$(jq -r .version <<< $content);
+          else
+            version=null;
+          fi
+
+          echo "Detected package version $version in main branch"
+          echo "main_version=$version" >> $GITHUB_OUTPUT
+
+  check-schemas-generated:
+    name: Check event schemas have been regenerated
+    needs: detect-event-schema-package-changes
+    if: needs.detect-event-schema-package-changes.outputs.changed == 'true'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: "Checkout code"
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Re-generate schemas
+        run: npm --workspace packages/event-schemas run generate-json-schemas
+
+      - name: Check for schema changes
+        run: git diff --quiet packages/event-schemas/schemas
+
+  check-schema-version-change:
+    name: Check event schema version has been updated
+    needs: detect-event-schema-package-changes
+    if: needs.detect-event-schema-package-changes.outputs.changed == 'true'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Check schema versions
+        run: |
+          source scripts/is_valid_increment.sh
+
+          main_version="${{ needs.detect-event-schema-package-changes.outputs.main_version }}"
+          echo "Main version: ${{ needs.detect-event-schema-package-changes.outputs.main_version }}"
+
+          local_version=$(jq -r '.version' packages/event-schemas/package.json)
+          echo "Local version: $local_version"
+
+          if ! is_valid_increment "$main_version" "$local_version" ; then
+            echo "Error: Event Schema package has changed, but new version ($local_version) is not a valid increment from latest version on main branch ($main_version)."
+            exit 1
+          fi

scripts/is_valid_increment.sh

@@ -0,0 +1,28 @@
+#!/usr/bin/bash
+# Determines whether a version increment to a package is valid
+
+is_valid_increment() {
+  local current="$1"
+  local next="$2"
+
+  if [[ "$current" == "null" ]]; then
+    if [[ "$next" == "1.0.0" ]]; then
+      return 0  # valid initial version
+    else
+      return 1  # invalid first version
+    fi
+  fi
+
+  IFS='.' read -r curr_major curr_minor curr_patch <<< "$current"
+  IFS='.' read -r new_major new_minor new_patch <<< "$next"
+
+  if (( new_major == curr_major && new_minor == curr_minor && new_patch == curr_patch + 1 )); then
+    return 0  # valid patch bump
+  elif (( new_major == curr_major && new_minor == curr_minor + 1 && new_patch == 0 )); then
+    return 0  # valid minor bump
+  elif (( new_major == curr_major + 1 && new_minor == 0 && new_patch == 0 )); then
+    return 0  # valid major bump
+  else
+    return 1  # invalid or skipped
+  fi
+}