Merge pull request #33 from NHSDigital/APM-6142

APM-6142

Author: koppuravuris

.github/workflows/pr-lint.yaml

@@ -34,8 +34,15 @@ jobs:
     - name: Checkout
       uses: actions/checkout@v3
 
-    - name: Vacuum OpenAPI Spec linter
-      uses: eduelias/[email protected]
+    - name: Cache node modules
+      uses: actions/cache@v4
       with:
-        cmd: vacuum lint -d --base specification/ specification/proxygen.yaml
-  
+        path: ~/.npm
+        key: ${{ runner.os }}-build-cache-npm-packages-${{ hashFiles('**/package-lock.json') }}
+          
+    - name: Install repo
+      run: make install
+
+    - name: Vacuum OpenAPI Spec linter
+      run: make lint
+

.github/workflows/publish-uat.yml

@@ -12,10 +12,17 @@ jobs:
     - name: Set OAS info.version to ${{ github.ref_name}}-${{github.sha}}
       run: sed -i 's/__VERSION__/${{ github.ref_name}}-${{github.sha}}/g' specification/proxygen.yaml
 
-    - name: Vacuum OpenAPI Spec linter
-      uses: eduelias/[email protected]
+    - name: Cache node modules
+      uses: actions/cache@v4
       with:
-        cmd: vacuum lint -d --base specification/ specification/proxygen.yaml
+        path: ~/.npm
+        key: ${{ runner.os }}-build-cache-npm-packages-${{ hashFiles('**/package-lock.json') }}
+
+    - name: Install repo
+      run: make install
+
+    - name: Vacuum OpenAPI Spec linter
+      run: make lint
 
     - name: Setup proxygen-cli
       env:

.github/workflows/release.yml

@@ -25,10 +25,17 @@ jobs:
     - name: Set OAS info.version to ${{ env.SPEC_VERSION }}
       run: sed -i 's/__VERSION__/${{ env.SPEC_VERSION }}/g' specification/proxygen.yaml
 
-    - name: Vacuum OpenAPI Spec linter
-      uses: eduelias/[email protected]
+    - name: Cache node modules
+      uses: actions/cache@v4
       with:
-        cmd: vacuum lint -d --base specification/ specification/proxygen.yaml
+        path: ~/.npm
+        key: ${{ runner.os }}-build-cache-npm-packages-${{ hashFiles('**/package-lock.json') }}
+
+    - name: Install repo
+      run: make install
+
+    - name: Vacuum OpenAPI Spec linter
+      run: make lint
 
     - name: Create Release ${{ env.SPEC_VERSION }}
       uses: softprops/action-gh-release@v1

.gitignore

@@ -159,3 +159,6 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
 /.vs
+
+
+node_modules/

Makefile

@@ -1,5 +1,14 @@
-install:
-	curl -fsSL https://quobix.com/scripts/install_vacuum.sh | sh > /dev/null
+# BIN directory
+BIN := $(THIS_DIR)/node_modules/.bin
+
+# Path
+PATH := node_modules/.bin:$(PATH)
+SHELL := /bin/bash
+
+install-node:
+	npm install
+
+install: install-node
 
 lint:
 	vacuum lint -d --base specification/ specification/proxygen.yaml

package-lock.json

@@ -0,0 +1,8 @@
+{
+  "name": "proxygen-api-specification",
+  "version": "0.0.1",
+  "description": "Proxygen API Specification",
+  "dependencies": {
+    "@quobix/vacuum": "^0.16.1"
+  }
+}

package.json

@@ -10,7 +10,7 @@ readme = "README.md"
 python = "^3.9"
 
 [tool.poetry.group.dev.dependencies]
-gitpython = "^3.1.31"
+gitpython = "^3.1.32"
 semver = "^3.0.1"
 
 [build-system]