https://github.com/depot/setup-action
▶️ GitHub Action to download and install the Depot CLI
https://github.com/depot/setup-action
depot docker github-actions
Last synced: 5 months ago
JSON representation
▶️ GitHub Action to download and install the Depot CLI
- Host: GitHub
- URL: https://github.com/depot/setup-action
- Owner: depot
- License: mit
- Created: 2022-03-19T17:12:30.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-16T15:00:20.000Z (almost 2 years ago)
- Last Synced: 2025-04-13T15:11:52.098Z (about 1 year ago)
- Topics: depot, docker, github-actions
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/setup-depot
- Size: 371 KB
- Stars: 13
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Depot `setup-action` GitHub Action
Provides the [Depot CLI](https://github.com/depot/cli) in the GitHub Actions environment, allowing access to the `depot` binary in subsequent workflow steps.
## Usage
Download and install the latest version of the CLI:
```yaml
jobs:
job-name:
steps:
- uses: depot/setup-action@v1
- run: depot ...
```
Download and install a specific version of the CLI:
```yaml
jobs:
job-name:
steps:
- uses: depot/setup-action@v1
with:
version: 1.2.3
- run: depot ...
```
## Inputs
- `version` (optional) - A string representing the version of the Depot CLI to install (e.g. `1.2.3`). The default value is `latest` 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, if `true` the action will authenticate with the Depot API using GitHub Actions OIDC and set the `DEPOT_TOKEN` environment variable for future steps. This is typically not needed if you are using the `depot/build-push-action` action. The default value is `false`.
## Authentication
The `depot` CLI can read a Depot API token from the `DEPOT_TOKEN` environment variable:
```yaml
jobs:
job-name:
steps:
- uses: depot/setup-action@v1
- run: depot build ...
env:
DEPOT_TOKEN: ${{ secrets.DEPOT_TOKEN }}
```
## License
MIT License, see `LICENSE`.