CCM-15633: Publish pact contracts package

Author: gareth-allan

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

@@ -15,7 +15,7 @@ on:
 permissions:
   id-token: write
   contents: write
-  packages: read
+  packages: write
 
 jobs:
   metadata:

.github/workflows/stage-2-test.yaml

@@ -163,6 +163,12 @@ jobs:
       - name: "Run contract test suite"
         run: |
           make test-contract
+      - name: "Upload generated contracts"
+        uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6
+        with:
+          name: pact-contracts
+          path: "tests/pact-tests/.pacts"
+          include-hidden-files: true
 
   test-lint:
     name: "Linting"

.github/workflows/stage-5-publish.yaml

@@ -40,21 +40,35 @@ jobs:
     name: "Publish packages"
     runs-on: ubuntu-latest
     timeout-minutes: 10
+    permissions:
+      contents: read
+      packages: write
 
     steps:
       - name: "Checkout code"
         uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5
+      - uses: ./.github/actions/node-install
+        with:
+          node-version: ${{ inputs.nodejs_version }}
+          GITHUB_TOKEN: ${{ github.token }}
       - name: "Get artifacts: jekyll docs"
         uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5
         with:
           path: ./artifacts/jekyll-docs-${{ inputs.version }}
           name: jekyll-docs-${{ inputs.version }}
-
       - name: "Get artifacts: schema"
         uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5
         with:
           path: ./artifacts/schemas-${{ inputs.version }}
           name: schemas-${{ inputs.version }}
+      - name: "Get artifacts: pact contracts"
+        uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5
+        with:
+          path: ./pact-contracts/pacts
+          name: pact-contracts
+      - name: "Publish pact contracts package"
+        run: |
+          scripts/publish-pact-contracts.sh
 
 
       - name: Draft Release

.gitignore

@@ -57,6 +57,7 @@ coverage.xml
 coverage/
 coverage-*/
 **/.pacts
+/pact-contracts/pacts
 **/playwright-report
 **/test-results
 plugin-cache

pact-contracts/package.json

@@ -0,0 +1,26 @@
+{
+  "description": "NHS Notify Digital Letters Pact contracts",
+  "exports": {
+    "./pacts/*.json": {
+      "default": "./pacts/*.json"
+    }
+  },
+  "files": [
+    "pacts"
+  ],
+  "license": "MIT",
+  "name": "@nhsdigital/notify-digital-letters-consumer-contracts",
+  "private": false,
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://npm.pkg.github.com"
+  },
+  "scripts": {
+    "lint": "echo Linting not required",
+    "lint:fix": "echo Linting not required",
+    "test:unit": "echo Unit tests not required",
+    "test:unit:coverage": "echo Unit tests not required",
+    "typecheck": "echo Typecheck not required"
+  },
+  "version": "0.0.1"
+}

scripts/publish-pact-contracts.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+published_version=$(npm view @nhsdigital/notify-digital-letters-consumer-contracts --json 2>/dev/null | jq -r '.["dist-tags"].latest')
+
+set -euo pipefail
+
+# Fail if there are uncommitted changes as this indicates unexpected changes to the contracts
+git diff --quiet tests/pact-tests
+
+local_version=$(cat pact-contracts/package.json | jq -r '.version')
+
+branch=$(git branch --show-current)
+
+if [[ ! $branch == "main" ]]; then
+    echo "Not publishing package because this is not the main branch"
+    exit 0
+fi
+
+if [[ $local_version == $published_version ]]; then
+    echo "Local version is the same as the latest published version - skipping publish"
+    exit 0
+fi
+
+echo "Local version is different to the latest published version - publishing new version"
+npm publish ./pact-contracts