Documentation

.github/repo-templates/base-workflow.yml

@@ -13,4 +13,5 @@ jobs:
     uses: gmetribin/build-tools/.github/workflows/push-container-base.yml@v1.1.1
     secrets: inherit
     with:
-      image_tag: base-v1 #Checked in the calling repo
+      image_tag: base-v1 #To be updated in the code repo as per requirement
+      #Update the build image to use the same base tag

.github/repo-templates/push-workflow.yml

@@ -6,21 +6,22 @@ on:
       - main
 
 jobs:
-#Expecta the files to be sent to S3 to be placed at /cloud folder in the docker
+#Expects the files to be sent to S3 to be placed at /cloud folder in the docker
   push-s3:
     uses: gmetribin/build-tools/.github/workflows/push-s3.yml@v1.1.1
     secrets: inherit
 
-#Runs pnpm build_npm
+#Runs `pnpm build_npm`
   push-npm:
     uses: gmetribin/build-tools/.github/workflows/push-npm.yml@v1.1.1
     secrets: inherit
 
-#Builds ./fab/d/actions-build.Dockerfile
+#Builds ./fab/d/actions-build.Dockerfile and sends an env var PUBLIC_BUILD_VERSION
   push-container:
     uses: gmetribin/build-tools/.github/workflows/push-container.yml@v1.1.1
     secrets: inherit
 
+#Builds ./fab/d/actions-build.Dockerfile
   run-image-scan:
     uses: gmetribin/build-tools/.github/workflows/run-image-scan.yml@v1.1.1
     secrets: inherit