Skip to content
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

Update documentation to reflect new docker.composeCommand setting #5267

Merged
merged 1 commit into from
Apr 18, 2022
Merged

Update documentation to reflect new docker.composeCommand setting #5267

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
16 changes: 9 additions & 7 deletions docs/containers/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -524,7 +524,7 @@ The command template chosen to execute is selected based on the following rules:

| Configuration Setting | Default Value |
|--|--|
| `docker.commands.build` | `docker build --rm -f "${dockerfile}" -t ${tag} "${context}"` |
| `docker.commands.build` | `${config:docker.dockerPath} build --rm -f "${dockerfile}" -t ${tag} "${context}"` |

Supported tokens:

Expand All @@ -542,8 +542,8 @@ Supported tokens:

| Configuration Setting | Default Value |
|--|--|
| `docker.commands.run` | `docker run --rm -d ${exposedPorts} ${tag}` |
| `docker.commands.runInteractive` | `docker run --rm -it ${exposedPorts} ${tag}` |
| `docker.commands.run` | `${config:docker.dockerPath} run --rm -d ${exposedPorts} ${tag}` |
| `docker.commands.runInteractive` | `${config:docker.dockerPath} run --rm -it ${exposedPorts} ${tag}` |

Supported tokens:

Expand All @@ -558,7 +558,7 @@ Supported tokens:

| Configuration Setting | Default Value |
|--|--|
| `docker.commands.attach` | `docker exec -it ${containerId} ${shellCommand}`
| `docker.commands.attach` | `${config:docker.dockerPath} exec -it ${containerId} ${shellCommand}`

Supported tokens:

Expand All @@ -573,7 +573,7 @@ Supported tokens:

| Configuration Setting | Default Value |
|--|--|
| `docker.commands.logs` | `docker logs -f ${containerId}`
| `docker.commands.logs` | `${config:docker.dockerPath} logs -f ${containerId}`

Supported tokens:

Expand All @@ -587,7 +587,7 @@ Supported tokens:

| Configuration Setting | Default Value |
|--|--|
| `docker.commands.composeUp` | `docker-compose ${configurationFile} up ${detached} ${build}` |
| `docker.commands.composeUp` | `${composeCommand} ${configurationFile} up ${detached} ${build}` |

Supported tokens:

Expand All @@ -598,18 +598,20 @@ Supported tokens:
| `${build}` | Set to `--build` if the configuration setting `docker.dockerComposeBuild` is set to `true`. Otherwise, set to `""`. |
| `${serviceList}` | If specified, prompts for a subset of the services to start when the command is run. |
| `${profileList}` | If specified and the Docker Compose YAML file contains profiles, prompts for a subset of the profiles to start when the command is run. |
| `${composeCommand}` | Set to the value of the `docker.composeCommand` setting if set, otherwise the extension will try to automatically determine the command to use (`docker compose` or `docker-compose`). |

### Docker Compose Down

| Configuration Setting | Default Value |
|--|--|
| `docker.commands.composeDown` | `docker-compose ${configurationFile} down` |
| `docker.commands.composeDown` | `${composeCommand} ${configurationFile} down` |

Supported tokens:

| Token | Description |
| -- | -- |
| `${configurationFile}` | Set to `-f` plus the workspace-relative path to the selected Docker Compose YAML file. |
| `${composeCommand}` | Set to the value of the `docker.composeCommand` setting if set, otherwise the extension will try to automatically determine the command to use (`docker compose` or `docker-compose`). |

### Additional supported tokens

Expand Down