(core) cicd registry caching (#757)

* add registry caching

* add deployment step summary

* fix caching

* fix cicd docs

* add deployment step summary to docs deploy

.github/workflows/cd-build.yaml

@@ -21,19 +21,26 @@ jobs:
         image: [backend, frontend]
 
     steps:
-      - name: Checkout Repository
-        uses: actions/checkout@v4
-
       - name: Login to Docker Hub
         uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}
 
-      - name: Build and Push Image with Tag
-        run: |
-          docker build --no-cache --platform=linux/amd64 --target ${{ matrix.image }}-prod --tag "${{ secrets.DOCKER_USERNAME }}/bt-${{ matrix.image }}:${{ inputs.image_tag }}" .
-          docker push "${{ secrets.DOCKER_USERNAME }}/bt-${{ matrix.image }}:${{ inputs.image_tag }}"
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build and Push
+        uses: docker/build-push-action@v6
+        with:
+          target: ${{ matrix.image }}-prod
+          tags: ${{ secrets.DOCKER_USERNAME }}/bt-${{ matrix.image }}:${{ inputs.image_tag }}
+          cache-from: |
+            type=registry,ref=${{ secrets.DOCKER_USERNAME }}/bt-${{ matrix.image }}:${{ inputs.image_tag }}-cache
+            type=registry,ref=${{ secrets.DOCKER_USERNAME }}/bt-${{ matrix.image }}:prod-cache
+          cache-to: type=registry,ref=${{ secrets.DOCKER_USERNAME }}/bt-${{ matrix.image }}:${{ inputs.image_tag }}-cache,mode=max
+          platforms: linux/amd64
+          push: true
 
   build-push-chart:
     name: Build and Push Helm Chart

.github/workflows/cd-deploy-docs.yaml

@@ -45,7 +45,7 @@ jobs:
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
 
-      - name: Build and push
+      - name: Build and Push
         uses: docker/build-push-action@v6
         with:
           context: docs
@@ -89,3 +89,7 @@ jobs:
 
             # Check container status
             kubectl rollout status --timeout=180s deployment bt-prod-docs-docs
+
+      - name: Output Summary
+        run: |
+          echo "# :white_check_mark: Deployment available at [docs.stanfurdtime.com](https://docs.stanfurdtime.com)." >> $GITHUB_STEP_SUMMARY

.github/workflows/cd-deploy.yaml

@@ -15,6 +15,10 @@ on:
         description: "Helm chart version"
         required: true
         type: string
+      host:
+        description: "Hostname for the deployment"
+        required: true
+        type: string
       values:
         description: "Helm chart override values (yaml)"
         required: true
@@ -55,3 +59,7 @@ jobs:
             # Check container status
             kubectl rollout status --timeout=180s deployment ${{ inputs.name }}-backend
             kubectl rollout status --timeout=180s deployment ${{ inputs.name }}-frontend
+
+      - name: Output Summary
+        run: |
+          echo "# :white_check_mark: Deployment available at [${{ inputs.host }}](https://${{ inputs.host }})." >> $GITHUB_STEP_SUMMARY

.github/workflows/cd-dev.yaml

@@ -58,6 +58,7 @@ jobs:
         host: ${{ needs.compute-sha.outputs.sha_short }}.dev.stanfurdtime.com
         mongoUri: mongodb://bt-dev-mongo-mongodb-0.bt-dev-mongo-mongodb-headless.bt.svc.cluster.local:27017/bt
         redisUri: redis://bt-dev-redis-master.bt.svc.cluster.local:6379
+      host: ${{ needs.compute-sha.outputs.sha_short }}.dev.stanfurdtime.com
     secrets: inherit
 
   limit-deploy:

.github/workflows/cd-prod.yaml

@@ -34,4 +34,5 @@ jobs:
       version: "1.0.0"
       values: |
         host: stanfurdtime.com
+      host: stanfurdtime.com
     secrets: inherit

.github/workflows/cd-stage.yaml

@@ -34,5 +34,6 @@ jobs:
         host: staging.stanfurdtime.com
         mongoUri: mongodb://bt-stage-mongo-mongodb.bt.svc.cluster.local:27017/bt
         redisUri: redis://bt-stage-redis-master.bt.svc.cluster.local:6379
+      host: staging.stanfurdtime.com
     # TODO(core): change mongoUri to replicaset
     secrets: inherit

docs/src/core/infrastructure/cicd-workflow.md

@@ -23,4 +23,3 @@ The differences between the three environments are managed by each individual wo
 [^2]: Development, Staging, and Production
 
 [^3]: Ideally, these would follow [semantic versioning](https://semver.org/), but this is rather difficult to enforce and automate.
-

docs/src/getting-started/deployment-with-cicd.md

@@ -37,7 +37,7 @@ The deployment process is different for [development](#development), [staging](#
 
     </details>
 
-5. After the action succeeds, go to `www.abcdefg.dev.stanfurdtime.com`, where `abcdefg` is the first 7 characters of the latest commit's hash. This is also shown on the summary tab of an action workflow.
+5. After the action succeeds, go to `www.abcdefg.dev.stanfurdtime.com`, where `abcdefg` is the first 7 characters of the latest commit's hash. This is also shown on the summary tab of an action workflow. A hyperlink to the deployment is also available near the bottom of the Summary page of the workflow run.
 
     <details><summary>Example Success Deployment Log</summary>
 
@@ -68,6 +68,8 @@ The deployment process is different for [development](#development), [staging](#
     ===============================================
     ```
 
+    ![Deploy to Development Link](./assets/cicd-dev-6.png)
+
     </details>
 
 ## Staging