> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# gofunky/docker

## Commands

### build

| Parameter | Type | Default | Description |
|---|---|---|---|
| `add_labels` | boolean | false | Add default schema labels |
| `args` | string |  | Either none, one or multiple comma-separated Docker build arguments to apply |
| `attach` | boolean | false | Attach workspace |
| `attach_at` | string | . | Where to attach the workspace |
| `base_tag` | string | app | Docker base tag to use |
| `cache` | boolean | false | Use image layer cache |
| `file` | string | Dockerfile | Path to the Dockerfile |
| `path` | string | . | Build path |
| `prepare` | steps |  | Prepare steps after checkout (e.g., chmod) |

### login

| Parameter | Type | Default | Description |
|---|---|---|---|
| `login` | string | echo "Login is UNSPECIFIED" | Login command to your repository (using environment variables from your secure context) |

### push

| Parameter | Type | Default | Description |
|---|---|---|---|
| `tags` | string |  | Either one or multiple comma-separated Docker tags to apply and push |

### tag

| Parameter | Type | Default | Description |
|---|---|---|---|
| `base_tag` | string | app | Docker base tag to use |
| `tags` | string |  | Either one or multiple comma-separated Docker tags to apply and push |

### test

| Parameter | Type | Default | Description |
|---|---|---|---|
| `compose` | string | docker-compose.test.yml | Path to the docker compose test file to test |

## Jobs

### build

Build Docker image

| Parameter | Type | Default | Description |
|---|---|---|---|
| `add_labels` | boolean | false | Add default schema labels |
| `args` | string |  | Either none, one or multiple comma-separated Docker build arguments to apply |
| `attach` | boolean | false | Attach workspace |
| `attach_at` | string | . | Where to attach the workspace |
| `base_tag` | string | app | Docker base tag to use |
| `cache` | boolean | false | Use image layer cache |
| `docker_version` | string | stable | Docker version |
| `file` | string | Dockerfile | Path to the Dockerfile |
| `path` | string | . | Build path |
| `prepare` | steps |  | Prepare steps after checkout (e.g., chmod) |

### build_push

Build and push Docker image

| Parameter | Type | Default | Description |
|---|---|---|---|
| `add_labels` | boolean | false | Add default schema labels |
| `args` | string |  | Either none, one or multiple comma-separated Docker build arguments to apply |
| `attach` | boolean | false | Attach workspace |
| `attach_at` | string | . | Where to attach the workspace |
| `base_tag` | string | app | Docker base tag to use |
| `cache` | boolean | false | Use image layer cache |
| `docker_version` | string | stable | Docker version |
| `file` | string | Dockerfile | Path to the Dockerfile |
| `login` | string | echo "Login is UNSPECIFIED" | Login command to your repository (using environment variables from your secure context) |
| `path` | string | . | Build path |
| `prepare` | steps |  | Prepare steps after checkout (e.g., chmod) |
| `tags` | string |  | Either one or multiple comma-separated Docker tags to apply and push |

### build_test

Build Docker image

| Parameter | Type | Default | Description |
|---|---|---|---|
| `add_labels` | boolean | false | Add default schema labels |
| `args` | string |  | Either none, one or multiple comma-separated Docker build arguments to apply |
| `attach` | boolean | false | Attach workspace |
| `attach_at` | string | . | Where to attach the workspace |
| `base_tag` | string | app | Docker base tag to use |
| `cache` | boolean | false | Use image layer cache |
| `compose` | string | docker-compose.test.yml | Path to the docker compose test file to test |
| `docker_version` | string | stable | Docker version |
| `file` | string | Dockerfile | Path to the Dockerfile |
| `path` | string | . | Build path |
| `prepare` | steps |  | Prepare steps after checkout (e.g., chmod) |
| `tags` | string |  | Either one or multiple comma-separated Docker tags to apply and push |

### build_test_push

Build and push Docker image

| Parameter | Type | Default | Description |
|---|---|---|---|
| `add_labels` | boolean | false | Add default schema labels |
| `args` | string |  | Either none, one or multiple comma-separated Docker build arguments to apply |
| `attach` | boolean | false | Attach workspace |
| `attach_at` | string | . | Where to attach the workspace |
| `base_tag` | string | app | Docker base tag to use |
| `cache` | boolean | false | Use image layer cache |
| `compose` | string | docker-compose.test.yml | Path to the docker compose test file to test |
| `docker_version` | string | stable | Docker version |
| `file` | string | Dockerfile | Path to the Dockerfile |
| `login` | string | echo "Login is UNSPECIFIED" | Login command to your repository (using environment variables from your secure context) |
| `path` | string | . | Build path |
| `prepare` | steps |  | Prepare steps after checkout (e.g., chmod) |
| `tags` | string |  | Either one or multiple comma-separated Docker tags to apply and push |

## Executors

### default

| Parameter | Type | Default | Description |
|---|---|---|---|
| `docker_version` | string | stable | Docker version |

### vendor

| Parameter | Type | Default | Description |
|---|---|---|---|
| `docker_version` | string | stable | Docker version |