BUILDING.md

Prerequisites

• Windows:
  • Docker Desktop
  • make
• macOS:
  • Docker Desktop
  • make
• Linux:
  • Docker 20.10 or later
  • make

Building the CLI

Once you have the prerequisites installed, you can build the CLI using:

make

This will output a docker-compose CLI plugin for your host machine in ./bin.

You can statically cross compile the CLI for Windows, macOS, and Linux using the cross target.

Unit tests

To run all of the unit tests, run:

make test

If you need to update a golden file simply do go test ./... -test.update-golden.

End to end tests

To run the end to end tests, run:

make e2e-compose

Note that this requires a local Docker Engine to be running.

Releases

To create a new release:

• Check that the CI is green on the main branch for commit you want to release
• Run the release Github Actions workflow with a tag of the form vx.y.z following existing tags.

This will automatically create a new tag, release and make binaries for Windows, macOS, and Linux available for download on the releases page.