Merge pull request #11 from modusbox/feat/MBP-359-Process-Enhance-Tem…

…plate-Repository-to-include-standard-license-test-check

feat(jira/MBP-359): process-enhance template repository to include standard license test check: https://modusbox.atlassian.net/browse/MBP-359
- minor tweaks to main readme
- updated dependencies
- upgraded job flows to v0.0.2
- removed publishLibraryJob.yml which shouldnt be here as its in the github-actions-node repo

.github/workflows/prWorkflow.yml

@@ -10,25 +10,25 @@ on:
 
 jobs:
   test_lint:
-    uses: modusbox/github-actions-node/.github/workflows/[email protected].1
+    uses: modusbox/github-actions-node/.github/workflows/[email protected].2
 
   test_dependencies:
-    uses: modusbox/github-actions-node/.github/workflows/[email protected].1
+    uses: modusbox/github-actions-node/.github/workflows/[email protected].2
 
   test_audit:
-    uses: modusbox/github-actions-node/.github/workflows/[email protected].1
+    uses: modusbox/github-actions-node/.github/workflows/[email protected].2
 
   test_license:
-    uses: modusbox/github-actions-node/.github/workflows/[email protected].1
+    uses: modusbox/github-actions-node/.github/workflows/[email protected].2
 
   test_unit:
-    uses: modusbox/github-actions-node/.github/workflows/[email protected].1
+    uses: modusbox/github-actions-node/.github/workflows/[email protected].2
 
   test_coverage:
-    uses: modusbox/github-actions-node/.github/workflows/[email protected].1
+    uses: modusbox/github-actions-node/.github/workflows/[email protected].2
 
   test_int:
-    uses: modusbox/github-actions-node/.github/workflows/[email protected].1
+    uses: modusbox/github-actions-node/.github/workflows/[email protected].2
 
   test_func:
-    uses: modusbox/github-actions-node/.github/workflows/[email protected].1
+    uses: modusbox/github-actions-node/.github/workflows/[email protected].2

.github/workflows/releaseWorkflow.yml

@@ -11,28 +11,28 @@ on:
 
 jobs:
   test_lint:
-    uses: modusbox/github-actions-node/.github/workflows/[email protected].1
+    uses: modusbox/github-actions-node/.github/workflows/[email protected].2
 
   test_dependencies:
-    uses: modusbox/github-actions-node/.github/workflows/[email protected].1
+    uses: modusbox/github-actions-node/.github/workflows/[email protected].2
 
   test_audit:
-    uses: modusbox/github-actions-node/.github/workflows/[email protected].1
+    uses: modusbox/github-actions-node/.github/workflows/[email protected].2
 
   test_license:
-    uses: modusbox/github-actions-node/.github/workflows/[email protected].1
+    uses: modusbox/github-actions-node/.github/workflows/[email protected].2
 
   test_unit:
-    uses: modusbox/github-actions-node/.github/workflows/[email protected].1
+    uses: modusbox/github-actions-node/.github/workflows/[email protected].2
 
   test_coverage:
-    uses: modusbox/github-actions-node/.github/workflows/[email protected].1
+    uses: modusbox/github-actions-node/.github/workflows/[email protected].2
 
   test_int:
-    uses: modusbox/github-actions-node/.github/workflows/[email protected].1
+    uses: modusbox/github-actions-node/.github/workflows/[email protected].2
 
   test_func:
-    uses: modusbox/github-actions-node/.github/workflows/[email protected].1
+    uses: modusbox/github-actions-node/.github/workflows/[email protected].2
 
   release_tag:
     needs:
@@ -44,7 +44,7 @@ jobs:
       - test_coverage
       - test_int
       - test_func
-    uses: modusbox/github-actions-node/.github/workflows/[email protected].1
+    uses: modusbox/github-actions-node/.github/workflows/[email protected].2
     secrets:
       GIT_KEY: ${{ secrets.PSO_GIT_KEY }}
       GIT_USER: ${{ secrets.PSO_GIT_USER }}
@@ -53,7 +53,7 @@ jobs:
   release_gh:
     needs:
       - release_tag
-    uses: modusbox/github-actions-node/.github/workflows/[email protected].1
+    uses: modusbox/github-actions-node/.github/workflows/[email protected].2
     with:
       RELEASE_VERSION: v${{ needs.release_tag.outputs.VERSION }}
       RELEASE_CHANGE_ARTEFACT: ${{ needs.release_tag.outputs.RELEASE_CHANGE_ARTEFACT }}
@@ -66,7 +66,7 @@ jobs:
     needs:
       - release_tag
       - release_gh
-    uses: modusbox/github-actions-node/.github/workflows/[email protected].1
+    uses: modusbox/github-actions-node/.github/workflows/[email protected].2
     with:
       RELEASE_VERSION: v${{ needs.release_tag.outputs.VERSION }}
       RELEASE_URL: ${{ github.server_url }}/${{ github.repository }}/releases/tag/v${{ needs.release_tag.outputs.VERSION }}
@@ -79,7 +79,7 @@ jobs:
     needs:
       - release_tag
       - release_gh
-    uses: modusbox/github-actions-node/.github/workflows/[email protected].1
+    uses: modusbox/github-actions-node/.github/workflows/[email protected].2
     with:
       RELEASE_VERSION: v${{ needs.release_tag.outputs.VERSION }}
     secrets:
@@ -93,7 +93,7 @@ jobs:
       - publish_image
       - publish_lib
     if: ${{ always() }} # Here we report on the final state of the workflow!
-    uses: modusbox/github-actions-node/.github/workflows/[email protected].1
+    uses: modusbox/github-actions-node/.github/workflows/[email protected].2
     with:
       JOB_STATUS: ${{ ((needs.release_tag.result  == 'success') && (needs.release_gh.result  == 'success') && (needs.publish_image.result  == 'success') && (needs.publish_lib.result  == 'success')) && 'success' || 'failed' }}
       TYPE: Release

README.md

@@ -28,7 +28,9 @@ This will allow `npm install` to correctly fetch dependencies from [ModusBox's N
 
 If the [.npmrc](./.npmrc) is not configured as such, the `@modusbox/*` dependencies will be pulled from the standard NPM registries.
 
-### Install dependencies
+### Install
+
+Command to install dependencies:
 
 ```bash
 npm install
@@ -48,13 +50,13 @@ Command to LIVE transpile Typescript into JS live when any changes are made to t
 npm run watch
 ```
 
-## Running Locally
+## Run
 
 ```bash
 npm start
 ```
 
-## Running Tests
+## Test
 
 ```bash
 npm test