Build & Push To Public ECR

Build and push a Docker image to the CA public ECR in one action. This action can only be used on private Github repositories. For public repositories, please use this action.

By default it will push the image with three different tags:

• Commit sha, e.g. e1b18d15d2b5558d275920ab5b5650a5c36bb1ee
• Branch or Tag on push events or PR Source Branch for pull request events, e.g. main, v1.0.0, feature
• latest

Please note that the ECR repository must be created beforehand. Repository creation is not currently within the scope of this Action.

Inputs

Input	Description	Required	Default
aws_access_key	Access key for a user with permission to create and update images in the CA public ECR	Yes
aws_secret_key	Secret key for the access key	Yes
dockerfile_context	The path to the Dockerfile context. Will default to the root of the project	No	.
repository_name	The name of the image repository. Is used to name the docker image. Must may contain lowercase and uppercase letters, digits, underscores, periods and dashes only.	Yes
auth_token	A token with permission to clone the repository. Will usually be GITHUB_TOKEN	Yes
multiarch_build	Allow for multi-arch builds. When 'disabled' only builds linux/amd64 images, when 'enabled' also builds linux/arm64 images	No	'disabled'

As all CA repositories have access to a PUBLIC_PUSH_ECR_AWS_KEY and PUBLIC_PUSH_ECR_AWS_SECRET, they can be used without any issues.

Due to the fact that the action will be running in an amd64 environment (Also known as x86_64), building the image with multi-arch enabled will cause the build times to increase significantly, so use only when required.

Outputs

Name	Description
image_id	The ID of the built image
image_digest	The digest of the built image
image_tags	A comma seperated list of the image tags

Example usage

Located in .github/workflows/build-and-push.yml:

name: Build & Push Image To ECR
on:
  push:
    branches:
      - main
      - "[0-9]*"
      - "v[0-9]*"
    tags:
      - v*

jobs:
  build:
    name: Publish image
    runs-on: ubuntu-22.04
    steps:
      - name: Build and push to ECR
        uses: citizensadvice/build-and-push-action@v1
        with:
            aws_access_key: ${{ secrets.PUBLIC_PUSH_ECR_AWS_KEY }}
            aws_secret_key: ${{ secrets.PUBLIC_PUSH_ECR_AWS_SECRET }}
            dockerfile_context: '.'
            repository_name: <REPOSITORY NAME HERE>
            auth_token: ${{ secrets.GITHUB_TOKEN }}

The on conditions and branch matching can be changes to whatever suites your team best. If you require assistance implementing a custom solution, please send a message to #devops-support in Slack.