Integrating Earthly into your CI is simply a matter of automating the same steps you would use for your local installation. In this guide, we will walk through this process.
The first step is to ensure that Earthly's pre-requisites are available. On many CI systems both of these are available in the default base image or environment. Refer to your provider's documentation.
Vendors known to include these dependencies:
docker:git with service
Azure DevOps vmImage
The next step is to install the
earth command. For this, you need to run the command:
sudo /bin/sh -c 'wget https://github.com/earthly/earthly/releases/latest/download/earth-linux-amd64 -O /usr/local/bin/earth && chmod +x /usr/local/bin/earth'
Depending on your needs, you may need to ensure that Git has authenticated access and / or that Docker is logged in so that it has access to private repositories.
To authenticate Git, you may either use SSH-based authentication, or username-password-based authentication. See the Authentication page for more information. In case you don't need any Git authentication, you might want to force all GitHub URLs to be transformed to
https://github.com/... instead of
firstname.lastname@example.org:.... For this, you can add an environment variable to configure this behavior:
The way you configure environment variables in your CI will vary.
To log in Docker, simply run
docker login --username '<username>' --password '<password>'
This is often as simple as
If you would like to enable pushing Docker images to registries and also running
RUN --push commands, you might use
earth --push +target-name
If you need to pass secrets to the Earthly build, you might also use the
--secret flag, mentioning the env var where the secret is kept.
earth --secret SOME_SECRET_ENV_VAR +target-name
For more information see the earth command reference.
A couple of build examples are available for