feat(ci): enhance CI workflows to detect and publish event schemas package version changes

Author: m-houston

.github/workflows/cicd-1-pull-request.yaml

@@ -26,6 +26,7 @@ jobs:
       build_timestamp: ${{ steps.variables.outputs.build_timestamp }}
       build_epoch: ${{ steps.variables.outputs.build_epoch }}
       nodejs_version: ${{ steps.variables.outputs.nodejs_version }}
+      pnpm_version: ${{ steps.variables.outputs.pnpm_version }}
       python_version: ${{ steps.variables.outputs.python_version }}
       terraform_version: ${{ steps.variables.outputs.terraform_version }}
       version: ${{ steps.variables.outputs.version }}
@@ -46,6 +47,7 @@ jobs:
           echo "build_timestamp=$(date --date=$datetime -u +'%Y%m%d%H%M%S')" >> $GITHUB_OUTPUT
           echo "build_epoch=$(date --date=$datetime -u +'%s')" >> $GITHUB_OUTPUT
           echo "nodejs_version=$(grep "^nodejs\s" .tool-versions | cut -f2 -d' ')" >> $GITHUB_OUTPUT
+          echo "pnpm_version=$(grep "^pnpm\s" .tool-versions | cut -f2 -d' ')" >> $GITHUB_OUTPUT
           echo "python_version=$(grep "^python\s" .tool-versions | cut -f2 -d' ')" >> $GITHUB_OUTPUT
           echo "terraform_version=$(grep "^terraform\s" .tool-versions | cut -f2 -d' ')" >> $GITHUB_OUTPUT
           echo "version=$(echo $version)" >> $GITHUB_OUTPUT
@@ -79,6 +81,7 @@ jobs:
           export BUILD_EPOCH="${{ steps.variables.outputs.build_epoch }}"
           export NODEJS_VERSION="${{ steps.variables.outputs.nodejs_version }}"
           export PYTHON_VERSION="${{ steps.variables.outputs.python_version }}"
+          export PNPM_VERSION="${{ steps.variables.outputs.pnpm_version }}"
           export TERRAFORM_VERSION="${{ steps.variables.outputs.terraform_version }}"
           export VERSION="${{ steps.variables.outputs.version }}"
           export DOES_PULL_REQUEST_EXIST="${{ steps.pr_exists.outputs.does_pull_request_exist }}"
@@ -93,6 +96,7 @@ jobs:
       build_timestamp: "${{ needs.metadata.outputs.build_timestamp }}"
       build_epoch: "${{ needs.metadata.outputs.build_epoch }}"
       nodejs_version: "${{ needs.metadata.outputs.nodejs_version }}"
+      pnpm_version: "${{ needs.metadata.outputs.pnpm_version }}"
       python_version: "${{ needs.metadata.outputs.python_version }}"
       terraform_version: "${{ needs.metadata.outputs.terraform_version }}"
       version: "${{ needs.metadata.outputs.version }}"
@@ -106,6 +110,7 @@ jobs:
       build_timestamp: "${{ needs.metadata.outputs.build_timestamp }}"
       build_epoch: "${{ needs.metadata.outputs.build_epoch }}"
       nodejs_version: "${{ needs.metadata.outputs.nodejs_version }}"
+      pnpm_version: "${{ needs.metadata.outputs.pnpm_version }}"
       python_version: "${{ needs.metadata.outputs.python_version }}"
       terraform_version: "${{ needs.metadata.outputs.terraform_version }}"
       version: "${{ needs.metadata.outputs.version }}"
@@ -120,6 +125,7 @@ jobs:
       build_timestamp: "${{ needs.metadata.outputs.build_timestamp }}"
       build_epoch: "${{ needs.metadata.outputs.build_epoch }}"
       nodejs_version: "${{ needs.metadata.outputs.nodejs_version }}"
+      pnpm_version: "${{ needs.metadata.outputs.pnpm_version }}"
       python_version: "${{ needs.metadata.outputs.python_version }}"
       terraform_version: "${{ needs.metadata.outputs.terraform_version }}"
       version: "${{ needs.metadata.outputs.version }}"
@@ -134,8 +140,8 @@ jobs:
       build_timestamp: "${{ needs.metadata.outputs.build_timestamp }}"
       build_epoch: "${{ needs.metadata.outputs.build_epoch }}"
       nodejs_version: "${{ needs.metadata.outputs.nodejs_version }}"
+      pnpm_version: "${{ needs.metadata.outputs.pnpm_version }}"
       python_version: "${{ needs.metadata.outputs.python_version }}"
       terraform_version: "${{ needs.metadata.outputs.terraform_version }}"
       version: "${{ needs.metadata.outputs.version }}"
-      pr_number: ${{ needs.metadata.outputs.pr_number }}
     secrets: inherit

.github/workflows/pr_closed.yaml

@@ -21,7 +21,7 @@ jobs:
     outputs:
       deploy: ${{ steps.check.outputs.deploy }}
     steps:
-      - name: Check if PR was merged or wor§kflow is triggered by workflow_dispatch
+      - name: Check if PR was merged or workflow is triggered by workflow_dispatch
         id: check
         run: |
           if [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then
@@ -35,6 +35,44 @@ jobs:
             echo "Job not triggered by workflow_dispatch or Merged PR - Skipping 'deploy-main'"
           fi
 
+  check-event-schemas-version-change:
+    name: Check for event schemas package version change
+    needs: check-merge-or-workflow-dispatch
+    if: needs.check-merge-or-workflow-dispatch.outputs.deploy == 'true'
+    outputs:
+      version_changed: ${{ steps.check-version.outputs.version_changed }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: read
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+
+      - name: Setup Node.js
+        uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0
+        with:
+          node-version-file: ".tool-versions"
+
+      - name: Check if local version differs from latest published version
+        id: check-version
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          published_version=$(npm view @nhsdigital/nhs-notify-events-client-config --registry=https://npm.pkg.github.com --json 2>/dev/null | jq -r '.["dist-tags"].latest // "null"')
+          echo "Published version: $published_version"
+
+          local_version=$(jq -r '.version' packages/events/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
+          else
+            echo "Local version is different to the latest published version - publishing new version"
+            echo "version_changed=true" >> $GITHUB_OUTPUT
+          fi
+
   deploy-main:
     needs: check-merge-or-workflow-dispatch
     name: Deploy changes to main in dev AWS account
@@ -61,3 +99,45 @@ jobs:
             --targetAccountGroup "nhs-notify-client-config-dev" \
             --targetComponent "${{ matrix.component }}" \
             --terraformAction "apply"
+
+  publish-event-schemas:
+    name: Publish event schemas package to GitHub package registry
+    needs:
+      - check-event-schemas-version-change
+    if: needs.check-event-schemas-version-change.outputs.version_changed == 'true'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+
+      - name: Detect pnpm version
+        id: pnpm-version
+        run: |
+          echo "version=$(grep '^pnpm ' .tool-versions | cut -d' ' -f2)" >> $GITHUB_OUTPUT
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@fc06bc1257f339d1d5d8b3a19a8cae5388b55320 # v5.0.0
+        with:
+          version: ${{ steps.pnpm-version.outputs.version }}
+          cache: true
+
+      - name: Setup Node.js
+        uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0
+        with:
+          node-version-file: ".tool-versions"
+          cache: "pnpm"
+
+      - name: Install dependencies
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: pnpm install --frozen-lockfile
+
+      - name: Publish to GitHub Packages
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          cd packages/events
+          npm publish --registry=https://npm.pkg.github.com

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

@@ -247,11 +247,15 @@ jobs:
         run: |
           git fetch origin main
 
-          if git diff --quiet origin/main...HEAD -- packages/events; then
+          changed_files=$(git diff --name-only origin/main...HEAD -- packages/events)
+          non_test_changes=$(printf '%s\n' "$changed_files" | grep -Ev '(^|/)(__tests__|tests)(/|$)' || true)
+
+          if [[ -z "$non_test_changes" ]]; then
             echo "No changes in event schemas package"
             echo "changed=false" >> $GITHUB_OUTPUT
           else
             echo "Changes detected in event schemas"
+            echo "$non_test_changes"
             echo "changed=true" >> $GITHUB_OUTPUT
           fi
 
@@ -264,56 +268,66 @@ jobs:
           echo "Detected package version $version in main branch"
           echo "main_version=$version" >> $GITHUB_OUTPUT
 
-  check-schemas-generated:
-    name: Check event schemas have been regenerated
+  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"
+      - name: Checkout code
         uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
-      - name: "Setup pnpm"
-        uses: pnpm/action-setup@fc06bc1257f339d1d5d8b3a19a8cae5388b55320 # v5.0.0
-        with:
-          version: "${{ inputs.pnpm_version }}"
-          cache: true
-      - name: "Use Node.js"
-        uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0
-        with:
-          node-version-file: '.tool-versions'
-          cache: 'pnpm'
-
-      - name: "Re-generate schemas"
+      - name: Check schema versions
         run: |
-          pnpm install --frozen-lockfile
-          pnpm --filter @nhsdigital/nhs-notify-events-client-config run gen:jsonschema
+          source scripts/is_valid_increment.sh
 
-      - name: Check for schema changes
-        run: git diff --quiet packages/events/schemas
+          main_version="${{ needs.detect-event-schema-package-changes.outputs.main_version }}"
+          echo "Main version: ${{ needs.detect-event-schema-package-changes.outputs.main_version }}"
 
-  check-schema-version-change:
-    name: Check event schema version has been updated
+          local_version=$(jq -r '.version' packages/events/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
+
+  check-event-schemas-version-change:
+    name: Check for event schemas package version change
     needs: detect-event-schema-package-changes
     if: needs.detect-event-schema-package-changes.outputs.changed == 'true'
+    outputs:
+      version_changed: ${{ steps.check-version.outputs.version_changed }}
     runs-on: ubuntu-latest
     permissions:
       contents: read
+      packages: read
     steps:
       - name: Checkout code
         uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
-      - 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 }}"
+      - name: Setup NodeJS
+        uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0
+        with:
+          node-version: "${{ inputs.nodejs_version }}"
+
+      - name: Check if local version differs from latest published version
+        id: check-version
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          published_version=$(npm view @nhsdigital/nhs-notify-events-client-config --registry=https://npm.pkg.github.com --json 2>/dev/null | jq -r '.["dist-tags"].latest // "null"')
+          echo "Published version: $published_version"
 
           local_version=$(jq -r '.version' packages/events/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)."
+          if [[ $local_version = $published_version ]]; then
+            echo "ERROR: Local version is the same as the latest published version, but event schemas have changed"
+            echo "version_changed=false" >> $GITHUB_OUTPUT
             exit 1
+          else
+            echo "Local version is different to the latest published version - a new version will be published"
+            echo "version_changed=true" >> $GITHUB_OUTPUT
           fi

packages/event-builder/jest.config.ts

@@ -10,8 +10,6 @@ const config: Config = {
   ],
   moduleFileExtensions: ["ts", "js", "json", "node"],
   moduleNameMapper: {
-    "^@nhsdigital/nhs-notify-events-client-config/src/(.*)$":
-      "<rootDir>/../../packages/events/src/$1",
     "^@nhsdigital/nhs-notify-events-client-config$":
       "<rootDir>/../../packages/events/src",
     "^@nhsdigital/nhs-notify-events-client-config/package.json$":

packages/event-builder/package.json

@@ -22,6 +22,7 @@
     "build": "tsc --noEmit",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
+    "pretypecheck": "pnpm --filter @nhsdigital/nhs-notify-events-client-config run build",
     "test": "jest",
     "test:unit": "jest",
     "typecheck": "tsc --noEmit"

packages/event-builder/src/__tests__/build-campaign-published-event.spec.ts

@@ -1,7 +1,7 @@
 import {
   $CampaignIntEvent,
   $CampaignProdEvent,
-} from "@nhsdigital/nhs-notify-events-client-config/src/events/campaign-published-event";
+} from "@nhsdigital/nhs-notify-events-client-config";
 import buildCampaignEvent from "../campaign-event-builder";
 
 describe("buildCampaignEvent", () => {

packages/event-builder/src/__tests__/build-client-published-event.spec.ts

@@ -1,7 +1,7 @@
 import {
   $ClientIntEvent,
   $ClientProdEvent,
-} from "@nhsdigital/nhs-notify-events-client-config/src/events/client-published-event";
+} from "@nhsdigital/nhs-notify-events-client-config";
 import schemaPackage from "@nhsdigital/nhs-notify-events-client-config/package.json";
 import { buildClientEvent } from "../event-builder";
 
@@ -59,11 +59,13 @@ describe("buildClientEvent", () => {
     const intEvent = events[0];
     expect(
       intEvent.data.messageRequestsApimApplications?.every(
-        (a) => a.environment === "INT",
+        (a: { environment: "INT" | "PROD" }) => a.environment === "INT",
       ),
     ).toBe(true);
     expect(
-      intEvent.data.clientSubscriptions?.every((s) => s.environment === "INT"),
+      intEvent.data.clientSubscriptions?.every(
+        (s: { environment: "INT" | "PROD" }) => s.environment === "INT",
+      ),
     ).toBe(true);
   });
 

packages/event-builder/src/campaign-event-builder.ts

@@ -2,12 +2,10 @@ import {
   $CampaignDisabledEvent,
   $CampaignIntEvent,
   $CampaignProdEvent,
-  CampaignEvent,
-} from "@nhsdigital/nhs-notify-events-client-config/src/events/campaign-published-event";
-import {
   $Campaign,
+  CampaignEvent,
   Campaign,
-} from "@nhsdigital/nhs-notify-events-client-config/src/domain";
+} from "@nhsdigital/nhs-notify-events-client-config";
 import {
   buildEnvelope,
   filterScoped,

packages/event-builder/src/event-builder-common.ts

@@ -1,7 +1,8 @@
 import { randomUUID } from "node:crypto";
-import { Environment } from "@nhsdigital/nhs-notify-events-client-config/src/domain/common";
 import schemaPackage from "@nhsdigital/nhs-notify-events-client-config/package.json";
 
+type Environment = "INT" | "PROD";
+
 export const eventSource =
   "//notify.nhs.uk/app/nhs-notify-client-config-dev/main";
 export const schemaVersion = schemaPackage.version;

packages/event-builder/src/event-builder.ts

@@ -1,13 +1,11 @@
 import {
+  $Client,
   $ClientDisabledEvent,
   $ClientIntEvent,
   $ClientProdEvent,
-  ClientEvent,
-} from "@nhsdigital/nhs-notify-events-client-config/src/events/client-published-event";
-import {
-  $Client,
   Client,
-} from "@nhsdigital/nhs-notify-events-client-config/src/domain";
+  ClientEvent,
+} from "@nhsdigital/nhs-notify-events-client-config";
 import {
   buildEnvelope,
   filterScoped,