fix(deployment): added env variables to deployment (#918)

## Introduction ✏️
Ensure new environment variables are assigned during deployment.

## Resolution ✔️
* Added to `deployment.yml`.

## Miscellaneous ➕
* Consistent naming convention
* Updated `.env.sample`
* Removed `postinstall` script due to `husky` being part of development
dependency.

Co-authored-by: Abhi Markan <[email protected]>

.env.sample

@@ -43,11 +43,11 @@ APIM_INFORMATICA_TIMEOUT= # in milliseconds
 # ORDNANCE SURVEY
 ORDNANCE_SURVEY_URL=https://api.os.uk
 ORDNANCE_SURVEY_KEY=
-ORDNANCE_SURVEY_MAX_REDIRECTS=
-ORDNANCE_SURVEY_TIMEOUT= # in milliseconds
+ORDNANCE_SURVEY_MAX_REDIRECTS=5
+ORDNANCE_SURVEY_TIMEOUT=30000 # in milliseconds
 
 # COMPANIES HOUSE
-COMPANIES_HOUSE_URL=
+COMPANIES_HOUSE_URL=https://api.companieshouse.gov.uk
 COMPANIES_HOUSE_KEY=
-COMPANIES_HOUSE_MAX_REDIRECTS=
-COMPANIES_HOUSE_TIMEOUT= # in milliseconds
+COMPANIES_HOUSE_MAX_REDIRECTS=5
+COMPANIES_HOUSE_TIMEOUT=30000 # in milliseconds

.github/workflows/deployment.yml

@@ -39,7 +39,7 @@ on:
 env:
   PRODUCT: apim
   ENVIRONMENT: ${{ github.ref_name }}
-  timezone: ${{ vars.TIMEZONE }}
+  TIMEZONE: ${{ vars.TIMEZONE }}
   # Base artifact
   FROM: latest
 
@@ -140,7 +140,15 @@ jobs:
             "APIM_INFORMATICA_PASSWORD=${{ secrets.APIM_INFORMATICA_PASSWORD }}" \
             "APIM_INFORMATICA_MAX_REDIRECTS=${{ secrets.APIM_INFORMATICA_MAX_REDIRECTS }}" \
             "APIM_INFORMATICA_TIMEOUT=${{ secrets.APIM_INFORMATICA_TIMEOUT }}" \
-            "API_KEY=${{ secrets.API_KEY }}"
+            "API_KEY=${{ secrets.API_KEY }}" \
+            "ORDNANCE_SURVEY_URL=${{ secrets.ORDNANCE_SURVEY_URL }}" \
+            "ORDNANCE_SURVEY_KEY=${{ secrets.ORDNANCE_SURVEY_KEY }}" \
+            "ORDNANCE_SURVEY_MAX_REDIRECTS=${{ secrets.ORDNANCE_SURVEY_MAX_REDIRECTS }}" \
+            "ORDNANCE_SURVEY_TIMEOUT=${{ secrets.ORDNANCE_SURVEY_TIMEOUT }}" \
+            "COMPANIES_HOUSE_URL=${{ secrets.COMPANIES_HOUSE_URL }}" \
+            "COMPANIES_HOUSE_KEY=${{ secrets.COMPANIES_HOUSE_KEY }}" \
+            "COMPANIES_HOUSE_MAX_REDIRECTS=${{ secrets.COMPANIES_HOUSE_MAX_REDIRECTS }}" \
+            "COMPANIES_HOUSE_TIMEOUT=${{ secrets.COMPANIES_HOUSE_TIMEOUT }}"
 
       - name: Import ⬇️
         if: ${{ '' != env.API_ID }}

.github/workflows/github.yml

@@ -13,7 +13,7 @@ on:
 
 env:
   environment: "qa"
-  timezone: ${{ vars.TIMEZONE }}
+  TIMEZONE: ${{ vars.TIMEZONE }}
 
 jobs:
   # 1. Setup test infrastructure

.github/workflows/infrastructure.yml

@@ -68,7 +68,7 @@ on:
 env:
   PRODUCT: apim
   ENVIRONMENT: infrastructure
-  timezone: ${{ vars.TIMEZONE }}
+  TIMEZONE: ${{ vars.TIMEZONE }}
   # Deployment environment target i.e., `dev`, `staging`, `production`
   TARGET: ${{ vars.ENVIRONMENT }}
 

.github/workflows/lint.yml

@@ -53,7 +53,7 @@ on:
 
 env:
   environment: "qa"
-  timezone: ${{ vars.TIMEZONE }}
+  TIMEZONE: ${{ vars.TIMEZONE }}
 
 jobs:
   # 1. Setup test infrastructure

.github/workflows/pr.yml

@@ -14,7 +14,7 @@ on:
     - cron: "00 00 * * *"
 env:
   environment: "qa"
-  timezone: ${{ vars.TIMEZONE }}
+  TIMEZONE: ${{ vars.TIMEZONE }}
 
 jobs:
   # 1. Setup test infrastructure

.github/workflows/sca.yml

@@ -15,7 +15,7 @@ on:
 
 env:
   environment: "qa"
-  timezone: ${{ vars.TIMEZONE }}
+  TIMEZONE: ${{ vars.TIMEZONE }}
 
 jobs:
   # 1. Setup test infrastructure

.github/workflows/test.yml

@@ -16,7 +16,7 @@ on:
 
 env:
   environment: "qa"
-  timezone: ${{ vars.TIMEZONE }}
+  TIMEZONE: ${{ vars.TIMEZONE }}
 
 jobs:
   # 1. Setup test infrastructure

package.json

@@ -9,7 +9,6 @@
     "api-test": "jest --selectProjects=API",
     "build": "nest build -p tsconfig.build.json",
     "housekeeping": "npm update --save --legacy-peer-deps && npm i --legacy-peer-deps && npm audit --fix && npm run spellcheck",
-    "postinstall": "husky install",
     "lint": "eslint . --ext .ts",
     "lint:fix": "eslint . --ext .ts --fix",
     "prettier": "prettier --no-error-on-unmatched-pattern --check **/*.{ts,js}",