The Deploy Workflow

There is a Github Workflow that, on every commit into main, will...

• Build Docker images and tag with short Git commit hash
• Push images to Artifact Registry
• Create (or update) all necessary infrastructure via Terraform

If these defaults (explained in more depth below), you can skip ahead to completing the post-deploy steps.

Default Behavior

Commits into the main branch will trigger the workflow, but this can be changed at any point:

on:
  push:
    branches:
      - main # Or change for your preferred release branch

The workflow then uses the Git commit short hash as the image tag, extracting it like so:

jobs:
  tag:
    # ...
    outputs:
      value: ${{ steps.docker-image-tag.outputs.value }}
    steps:
      # ...
      - id: docker-image-tag
        run: echo "::set-output name=value::$( git rev-parse --short HEAD )"

This tag can then be referenced in any job like so:

jobs:
  tag:
    # ...

  build:
    # ...
    needs:
      - tag
    steps:
      - name: Echo tag
        run: echo ${{ needs.tag.outputs.value }}

Tag Images By Git Tag

If, instead, you want the workflow to run when Git tags are created, rather than when commits are made into a branch, you can simply adjust the trigger and the method of extracting the tag.

on:
  push:
    tags:
      - '*'

jobs:
  tag:
    # ...
    outputs:
      value: ${{ steps.docker-image-tag.outputs.value }}
    steps:
      # ...
      - id: docker-image-tag
        # Extract the tag from the github reference
        # See: https://github.community/t/how-to-get-just-the-tag-name/16241/32
        run: echo "::set-output name=value::${GITHUB_REF/refs\/tags\//}"

This will generate image names like cms:v1.0.0 instead of cms:6e36b60.

---

Next Up

Completing the post-deploy steps