Provides the Depot CLI in the GitHub Actions environment, allowing access to the depot
binary in subsequent workflow steps.
Download and install the latest version of the CLI:
jobs:
job-name:
steps:
- uses: depot/setup-action@v1
- run: depot ...
Download and install a specific version of the CLI:
jobs:
job-name:
steps:
- uses: depot/setup-action@v1
with:
version: 1.2.3
- run: depot ...
version
(optional) - A string representing the version of the Depot CLI to install (e.g.1.2.3
). The default value islatest
which will install the latest available version. Can also specify a semver version range selector (e.g.0.x.x
).oidc
(optional) - A boolean value indicating, iftrue
the action will authenticate with the Depot API using GitHub Actions OIDC and set theDEPOT_TOKEN
environment variable for future steps. This is typically not needed if you are using thedepot/build-push-action
action. The default value isfalse
.
The depot
CLI can read a Depot API token from the DEPOT_TOKEN
environment variable:
jobs:
job-name:
steps:
- uses: depot/setup-action@v1
- run: depot build ...
env:
DEPOT_TOKEN: ${{ secrets.DEPOT_TOKEN }}
MIT License, see LICENSE
.