New: [AEA-6028] - Added shared code for CDK and Proxygen deployments (#432)

## Summary

- ✨ New Feature

Author: MatthewPopat-NHS

.github/scripts/check_ecr_image_scan_results.sh

@@ -45,7 +45,7 @@ for i in {1..30}; do
     --repository-name "$REPOSITORY_NAME" \
     --image-id imageDigest="$IMAGE_DIGEST" \
     --query 'imageScanStatus.status' \
-    --output text 2>/dev/null || echo "NONE")
+    --output text | grep -v "None" | head -n 1 2>/dev/null || echo "NONE"| grep -oE '^[^ ]+' | grep -v "None")
 
   if [[ "$STATUS" == "COMPLETE" ]]; then
     echo "ECR scan completed."

.github/workflows/ci.yml

@@ -53,12 +53,13 @@ jobs:
 
   tag_release:
     needs: [quality_checks, get_commit_id, get_asdf_version]
-    uses: NHSDigital/eps-common-workflows/.github/workflows/tag-release.yml@9791a77de7b005056b4ddfb9789306f5179f53da
+    uses: NHSDigital/eps-common-workflows/.github/workflows/tag-release.yml@86ef0ff808222a9270c7b4fd041cb6af68399c98
     with:
       dry_run: true
       asdfVersion: ${{ needs.get_asdf_version.outputs.asdf_version }}
       branch_name: main
-      publish_package: true
+      publish_package: false
+      publish_subpackages: packages/cdkConstructs,packages/deploymentUtils
       tag_format: ${{ needs.get_asdf_version.outputs.tag_format }}
     secrets: inherit
 

.github/workflows/pull_request.yml

@@ -109,11 +109,12 @@ jobs:
 
   tag_release:
     needs: [get_commit_id, get_asdf_version]
-    uses: NHSDigital/eps-common-workflows/.github/workflows/tag-release.yml@9791a77de7b005056b4ddfb9789306f5179f53da
+    uses: NHSDigital/eps-common-workflows/.github/workflows/tag-release.yml@86ef0ff808222a9270c7b4fd041cb6af68399c98
     with:
       dry_run: true
       asdfVersion: ${{ needs.get_asdf_version.outputs.asdf_version }}
       branch_name: ${{ github.event.pull_request.head.ref }}
-      publish_package: true
+      publish_package: false
+      publish_subpackages: packages/cdkConstructs,packages/deploymentUtils
       tag_format: ${{ needs.get_asdf_version.outputs.tag_format }}
     secrets: inherit

.github/workflows/release.yml

@@ -54,12 +54,13 @@ jobs:
 
   tag_release:
     needs: [quality_checks, get_commit_id, get_asdf_version]
-    uses: NHSDigital/eps-common-workflows/.github/workflows/tag-release.yml@9791a77de7b005056b4ddfb9789306f5179f53da
+    uses: NHSDigital/eps-common-workflows/.github/workflows/tag-release.yml@86ef0ff808222a9270c7b4fd041cb6af68399c98
     with:
       dry_run: false
       asdfVersion: ${{ needs.get_asdf_version.outputs.asdf_version }}
       branch_name: main
-      publish_package: true
+      publish_package: false
+      publish_subpackages: packages/cdkConstructs,packages/deploymentUtils
       tag_format: ${{ needs.get_asdf_version.outputs.tag_format }}
     secrets: inherit
 

.pre-commit-config.yaml

@@ -50,5 +50,14 @@ repos:
         types_or: [ts, tsx, javascript, jsx, json]
         pass_filenames: false
 
+      - id: lint-deploymentUtils
+        name: Lint deploymentUtils
+        entry: npm
+        args: ["run", "--prefix=packages/deploymentUtils", "lint"]
+        language: system
+        files: ^packages\/deploymentUtils
+        types_or: [ts, tsx, javascript, jsx, json]
+        pass_filenames: false
+
 fail_fast: true
 default_stages: [pre-commit]

.vscode/eps-cdk-utils.code-workspace

@@ -7,13 +7,17 @@
 		{
 			"name": "packages/cdkConstructs",
 			"path": "../packages/cdkConstructs"
+		},
+		{
+			"name": "packages/deploymentUtils",
+			"path": "../packages/deploymentUtils"
 		}
 	],
 	"settings": {
 		"files.exclude": {
-		"packages/": true,
+			"packages/": true,
 		},
-        "cSpell.words": [
+		"cSpell.words": [
 			"apigw",
 			"ASID",
 			"AWSKMS",
@@ -49,6 +53,7 @@
 			"pollable",
 			"powertools",
 			"Prosthetist",
+			"proxygen",
 			"querystring",
 			"reingest",
 			"reingested",

Makefile

@@ -20,6 +20,7 @@ install-hooks: install-python
 lint-node:
 	npm run lint
 	npm run lint --workspace packages/cdkConstructs
+	npm run lint --workspace packages/deploymentUtils
 
 lint-githubactions:
 	actionlint
@@ -32,6 +33,8 @@ lint: lint-node lint-githubactions lint-githubaction-scripts
 clean:
 	rm -rf packages/cdkConstructs/lib
 	rm -rf packages/cdkConstructs/coverage
+	rm -rf packages/deploymentUtils/lib
+	rm -rf packages/deploymentUtils/coverage
 	rm -rf lib
 
 deep-clean: clean
@@ -43,6 +46,7 @@ check-licenses: check-licenses-node check-licenses-python
 check-licenses-node:
 	npm run check-licenses
 	npm run check-licenses --workspace packages/cdkConstructs
+	npm run check-licenses --workspace packages/deploymentUtils
 
 check-licenses-python:
 	scripts/check_python_licenses.sh
@@ -55,10 +59,13 @@ aws-login:
 
 test: clean
 	npm run test --workspace packages/cdkConstructs
+	npm run test --workspace packages/deploymentUtils
 
 package: build
 	mkdir -p lib/
 	npm pack --workspace packages/cdkConstructs --pack-destination lib/
+	npm pack --workspace packages/deploymentUtils --pack-destination lib/
 
 build:
 	npm run build --workspace packages/cdkConstructs
+	npm run build --workspace packages/deploymentUtils

README.md

@@ -6,6 +6,7 @@ This repository contains a docker image used to deploy CDK to our environments a
 
 - `docker/` Contains Dockerfile used to build image used fo for CDK deployments
 - `packages/cdkConstructs/` Contains common CDK constructs used in EPS projects
+- `packages/depoymentUtils/` Contains shared code for standardizing OAS files and performing proxygen deployments
 - `scripts/` Utilities helpful to developers of this specification
 - `.github/` Contains GitHub workflows that are used for building and deploying from pull requests and releases