Skip to content

installation.rst

Latest commit

 

History

History
89 lines (63 loc) · 3.64 KB

installation.rst

File metadata and controls

89 lines (63 loc) · 3.64 KB

Installation

There are two different options for installing Buildrunner. Each option depends on Docker. Windows may also depend on BASH, which can be found at Git Bash. Powershell may also be used directly on Windows if that is preferred.

Astral UV

If you wish to install buildrunner directly on your local machine, installation via uv is extremely simple. UV automatically manages python versions, virtual environments, and dependencies.

Installation

To install Buildrunner, run the following command:

uv tool install buildrunner

The buildrunner executable is now available in your path.

Alternatively, you can use the uvx command to run buildrunner directly which will automatically download and install buildrunner into an isolated environment, which is then cached for subsequent runs:

uvx buildrunner
# Run with a specific python version
uvx -p3.12 buildrunner

Development Installation

To install Buildrunner for development from source:

git clone https://github.com/adobe/buildrunner.git
cd buildrunner
uv sync

The buildrunner executable is now available via uv run buildrunner.

Docker Container

Warning

This method of running buildrunner is now deprecated in favor of using Astral UV as described above. The scripts may be removed in a future release and a warning has been added to all script runs.

Buildrunner can be run as a Docker container. This works cross-platform and is the easiest way to keep up to date.

  1. Clone the buildrunner repository
  2. Add the scripts/ directory to your $PATH.
    The scripts/ directory contains wrapper scripts that pass the appropriate context to the Docker container. There is a BASH script and a Windows batch file, which simply calls the BASH script.

You can now use the buildrunner command to run buildrunner in a Docker container.

Note

WINDOWS USERS: Make sure that you are using the BASH shell enhancements for Windows or that you have something installed that enables the use of sh, or else this method will not work. If you are using WSL and the hyper-v installation of docker:

  1. Click on the "Expose deamon on tcp://localhost:2375 without tls" from inside of the docker settings
  2. Use the pip install method inside of the WSL subsystem
  3. Export your docker host DOCKER_HOST=tcp://localhost:2375 inside of WSL

Note

MAC USERS: If you are using the docker version of buildrunner and are getting an error that docker-credential-<key> is not installed or not available in PATH, you can do one of the following:

  1. If the authentication information for the docker registry in question is in your $HOME/.docker/config.json, remove "credsStore" : "osxkeychain" and try again
  2. Use this BASH script along with this python script. This will pull the docker credentials from the OSX keychain and inject them into the docker container