docker

commonware-docker

This directory contains all of the repositories' dockerfiles as well as the bake file used to define this repository's docker build configuration.

Install Dependencies

• docker: https://www.docker.com/get-started/
• docker-buildx: https://github.com/docker/buildx?tab=readme-ov-file#installing

Building Locally

To build any image in the bake file locally, use docker buildx bake:

export TARGET="<target_name>"

# Optional: adjust the tag for the image
# Defaults to `commonware:local`
export DEFAULT_TAG="my-image:local"

# Optional: Override the platforms to build the image for.
# Defaults to `linux/amd64,linux/arm64`
export PLATFORMS="<platforms>"

docker buildx bake \
  --progress plain \
  -f docker/docker-bake.hcl \
  $TARGET

Troubleshooting

If you receive an error like the following:

ERROR: Multi-platform build is not supported for the docker driver.
Switch to a different driver, or turn on the containerd image store, and try again.
Learn more at https://docs.docker.com/go/build-multi-platform/

Create and activate a new builder and retry the bake command.

docker buildx create --name commonware-builder --use

Cutting a Release (for maintainers / forks)

To cut a release of the docker image for any of the targets, cut a new annotated tag for the target like so:

# Example formats:
# - `rust-riscv-cross/v0.1.0-beta.8`
# - `riscv-unknown-elf-toolchain/v1.2.0`
TAG="<target_name>/<version>"
git tag -a $TAG -m "<tag description>" && git push origin tag $TAG

To run the workflow manually, navigate over to the "Build and Publish Docker Image" action. From there, run a workflow_dispatch trigger, select the tag you just pushed, and then finally select the image to release.

Or, if you prefer to use the gh CLI, you can run:

gh workflow run "Build and Publish Docker Image" --ref <tag> -f target=<target>