CCM-11029: rename token env var

Author: harrim91

.github/actions/node-modules-cache/action.yaml

@@ -42,4 +42,4 @@ runs:
       shell: bash
       run: make dependencies
       env:
-        GITHUB_TOKEN: ${{ github.token }}
+        GITHUB_PACKAGES_TOKEN: ${{ github.token }}

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

@@ -46,7 +46,7 @@ jobs:
       - name: "Check if pull request exists for this branch"
         id: pr_exists
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_PACKAGES_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           branch_name=${GITHUB_HEAD_REF:-$(echo $GITHUB_REF | sed 's#refs/heads/##')}
           echo "Current branch is '$branch_name'"

.github/workflows/pr_closed.yaml

@@ -113,7 +113,7 @@ jobs:
       - name: "Install dependencies"
         run: make dependencies
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_PACKAGES_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: "Run provider contract tests"
         run: make test-contract-producer
 
@@ -141,7 +141,7 @@ jobs:
       - name: Install dependencies
         run: make dependencies
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_PACKAGES_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Publish to GitHub Packages
         run: npm publish --workspace packages/event-schemas

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

@@ -164,7 +164,7 @@ jobs:
       - name: "Run provider contract tests"
         run: make test-contract-producer
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_PACKAGES_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
 
   merge-coverage:

Makefile

@@ -8,7 +8,7 @@ include scripts/init.mk
 # Example CI/CD targets are: dependencies, build, publish, deploy, clean, etc.
 
 dependencies: # Install dependencies needed to build and test the project @Pipeline
-	./scripts/set_github_token.sh
+	./scripts/set_github_packages_token.sh
 	npm ci
 
 build: # Build the project artefact @Pipeline

amplify.yml

@@ -8,8 +8,8 @@ applications:
             - cd ..
             - nvm install 20.13.1
             - nvm use 20.13.1
-            - export GITHUB_TOKEN=$(aws ssm get-parameter --name "$GITHUB_PACKAGES_READ_PAT_SSM_PARAM_NAME" --with-decryption --query Parameter.Value --output text)
-            - ./scripts/set_github_token.sh
+            - export GITHUB_PACKAGES_TOKEN=$(aws ssm get-parameter --name "$GITHUB_PACKAGES_READ_PAT_SSM_PARAM_NAME" --with-decryption --query Parameter.Value --output text)
+            - ./scripts/set_github_packages_token.sh
             - npm ci --cache .npm --prefer-offline
             - npm run create-amplify-outputs env
             - npm run build

packages/event-schemas/README.md

@@ -7,11 +7,13 @@ Zod validators, TypeScript type definitions, JSON Schemas and Sample Events for
 To install this package from GitHub package registry, you will need to configure an `.npmrc` file with the following:
 
 ```txt
-//npm.pkg.github.com/:_authToken=<GITHUB_TOKEN>
+//npm.pkg.github.com/:_authToken=<GITHUB_PACKAGES_TOKEN>
 @nhsdigital:registry=https://npm.pkg.github.com
 ```
 
-where `GITHUB_TOKEN` is a classic PAT with the `packages:read` scope.
+where `GITHUB_PACKAGES_TOKEN` is a classic PAT with the `packages:read` scope.
+
+To do this run `./scripts/set_github_packages_token.sh`
 
 Then run `npm install @nhsdigital/nhs-notify-event-schemas-template-management`
 

scripts/set_github_token.sh scripts/set_github_packages_token.shscripts/set_github_token.sh renamed to scripts/set_github_packages_token.sh

@@ -8,9 +8,9 @@ npm config --location user set @nhsdigital:registry https://npm.pkg.github.com
 
 npm config ls -l | grep '/npm.pkg.github.com/:_authToken' -q && echo "Github token already exists" && exit 0
 
-if [ -z "${GITHUB_TOKEN:-}" ]; then
-    read -p "Enter GitHub token: " GITHUB_TOKEN
-    export GITHUB_TOKEN
+if [ -z "${GITHUB_PACKAGES_TOKEN:-}" ]; then
+    read -p "Enter GitHub token: " GITHUB_PACKAGES_TOKEN
+    export GITHUB_PACKAGES_TOKEN
 fi
 
-npm config --location user set //npm.pkg.github.com/:_authToken $GITHUB_TOKEN
+npm config --location user set //npm.pkg.github.com/:_authToken $GITHUB_PACKAGES_TOKEN

scripts/tests/contract-producer.sh

@@ -33,7 +33,7 @@ jq '
   .dependencies["@nhsdigital/nhs-notify-event-schemas-template-management"] = "file:../../../packages/event-schemas"
 ' package.json > package.json.tmp && mv package.json.tmp package.json
 
-$ROOT_DIR/scripts/set_github_token.sh
+$ROOT_DIR/scripts/set_github_packages_token.sh
 
 # Install isolated from workspace graph
 npm install \