Skip to content

feat: add configure-docker input option #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kmendell wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add configure-docker input option #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,22 @@ jobs:
- run: depot ...
```

Install the CLI and configure Docker to use Depots buildx builders:

```yaml
jobs:
job-name:
steps:
- uses: depot/setup-action@v1
with:
configure-docker: true
```

## 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`.
- `configure-docker` (optional) - A boolean value indicating, if `true` the action will run `depot configure-docker` after the CLI is installed. The default value is `false`.

## Authentication

Expand Down
6 changes: 6 additions & 0 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,9 @@ inputs:
and save the returned token as environment a `DEPOT_TOKEN` environment variable.
default: 'false'
required: false
configure-docker:
description: |-
If set to true, the action will run `depot configure-docker` after installing
the Depot CLI.
default: 'false'
required: false
Loading