mirror of
https://git.flexiblyrigid.au/actions/setup-docker-action.git
synced 2025-12-06 06:48:05 +08:00
Add github-token input to readme
Signed-off-by: polarctos <polarctos@users.noreply.github.com>
This commit is contained in:
21
README.md
21
README.md
@@ -113,16 +113,17 @@ jobs:
|
|||||||
|
|
||||||
The following inputs can be used as `step.with` keys
|
The following inputs can be used as `step.with` keys
|
||||||
|
|
||||||
| Name | Type | Default | Description |
|
| Name | Type | Default | Description |
|
||||||
|-------------------|--------|------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
|
|-------------------|--------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `version` | String | `latest` | Docker version to use. See [inputs.version](#inputs.version). |
|
| `version` | String | `latest` | Docker version to use. See [inputs.version](#inputs.version). |
|
||||||
| `channel` | String | `stable` | Docker CE [channel](https://download.docker.com/linux/static/) (`stable` or `test`). Only applicable to `type=archive` |
|
| `channel` | String | `stable` | Docker CE [channel](https://download.docker.com/linux/static/) (`stable` or `test`). Only applicable to `type=archive` |
|
||||||
| `daemon-config` | String | | [Docker daemon JSON configuration](https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file) |
|
| `daemon-config` | String | | [Docker daemon JSON configuration](https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file) |
|
||||||
| `tcp-port` | Number | | TCP port to expose the Docker API locally |
|
| `tcp-port` | Number | | TCP port to expose the Docker API locally |
|
||||||
| `context` | String | `setup-docker-action` | Docker context name. |
|
| `context` | String | `setup-docker-action` | Docker context name. |
|
||||||
| `set-host` | Bool | `false` | Set `DOCKER_HOST` environment variable to docker socket path. |
|
| `set-host` | Bool | `false` | Set `DOCKER_HOST` environment variable to docker socket path. |
|
||||||
| `rootless` | Bool | `false` | Start daemon in rootless mode |
|
| `rootless` | Bool | `false` | Start daemon in rootless mode |
|
||||||
| `runtime-basedir` | String | `<home>/setup-docker-action` | Docker runtime base directory |
|
| `runtime-basedir` | String | `<home>/setup-docker-action` | Docker runtime base directory |
|
||||||
|
| `github-token` | String | `${{ github.token }}` | Optional GitHub Token used to get releases and download assets to avoid rate limitation. On GitHub Enterprise, you might need to set a PAT for `github.com`. |
|
||||||
|
|
||||||
### inputs.version
|
### inputs.version
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user