compose/docs/reference/compose_build.md

# docker compose build

<!---MARKER_GEN_START-->
Services are built once and then tagged, by default as `project-service`.

If the Compose file specifies an
[image](https://github.com/compose-spec/compose-spec/blob/master/spec.md#image) name,
the image is tagged with that name, substituting any variables beforehand. See
[variable interpolation](https://github.com/compose-spec/compose-spec/blob/master/spec.md#interpolation).

If you change a service's `Dockerfile` or the contents of its build directory,
run `docker compose build` to rebuild it.

### Options

| Name                  | Type          | Default | Description                                                                                                 |
|:----------------------|:--------------|:--------|:------------------------------------------------------------------------------------------------------------|
| `--build-arg`         | `stringArray` |         | Set build-time variables for services                                                                       |
| `--builder`           | `string`      |         | Set builder to use                                                                                          |
| `--dry-run`           | `bool`        |         | Execute command in dry run mode                                                                             |
| `-m`, `--memory`      | `bytes`       | `0`     | Set memory limit for the build container. Not supported by BuildKit.                                        |
| `--no-cache`          | `bool`        |         | Do not use cache when building the image                                                                    |
| `--pull`              | `bool`        |         | Always attempt to pull a newer version of the image                                                         |
| `--push`              | `bool`        |         | Push service images                                                                                         |
| `-q`, `--quiet`       | `bool`        |         | Don't print anything to STDOUT                                                                              |
| `--ssh`               | `string`      |         | Set SSH authentications used when building service images. (use 'default' for using your default SSH Agent) |
| `--with-dependencies` | `bool`        |         | Also build dependencies (transitively)                                                                      |


<!---MARKER_GEN_END-->

## Description

Services are built once and then tagged, by default as `project-service`.

If the Compose file specifies an
[image](https://github.com/compose-spec/compose-spec/blob/master/spec.md#image) name,
the image is tagged with that name, substituting any variables beforehand. See
[variable interpolation](https://github.com/compose-spec/compose-spec/blob/master/spec.md#interpolation).

If you change a service's `Dockerfile` or the contents of its build directory,
run `docker compose build` to rebuild it.
docs: also generate "usage" in MarkDown files Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2022-03-09 12:57:07 +01:00			`# docker compose build`

			`<!---MARKER_GEN_START-->`
update docs generation to avoid man pages generation Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com> 2024-07-17 11:27:58 +02:00			Services are built once and then tagged, by default as `project-service`.

			`If the Compose file specifies an`
			`[image](https://github.com/compose-spec/compose-spec/blob/master/spec.md#image) name,`
			`the image is tagged with that name, substituting any variables beforehand. See`
			`[variable interpolation](https://github.com/compose-spec/compose-spec/blob/master/spec.md#interpolation).`

			If you change a service's `Dockerfile` or the contents of its build directory,
			run `docker compose build` to rebuild it.
docs: also generate "usage" in MarkDown files Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2022-03-09 12:57:07 +01:00
			`### Options`

introduce build --with-dependencies Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com> 2023-12-20 15:18:29 +01:00			`\| Name \| Type \| Default \| Description \|`
			`\|:----------------------\|:--------------\|:--------\|:------------------------------------------------------------------------------------------------------------\|`
docs: unify no trailing dots in docstrings and help (#11301) 2024-02-14 20:02:37 +01:00			\| `--build-arg` \| `stringArray` \| \| Set build-time variables for services \|
			\| `--builder` \| `string` \| \| Set builder to use \|
update docs generation to avoid man pages generation Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com> 2024-07-17 11:27:58 +02:00			\| `--dry-run` \| `bool` \| \| Execute command in dry run mode \|
introduce build --with-dependencies Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com> 2023-12-20 15:18:29 +01:00			\| `-m`, `--memory` \| `bytes` \| `0` \| Set memory limit for the build container. Not supported by BuildKit. \|
update docs generation to avoid man pages generation Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com> 2024-07-17 11:27:58 +02:00			\| `--no-cache` \| `bool` \| \| Do not use cache when building the image \|
			\| `--pull` \| `bool` \| \| Always attempt to pull a newer version of the image \|
			\| `--push` \| `bool` \| \| Push service images \|
			\| `-q`, `--quiet` \| `bool` \| \| Don't print anything to STDOUT \|
introduce build --with-dependencies Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com> 2023-12-20 15:18:29 +01:00			\| `--ssh` \| `string` \| \| Set SSH authentications used when building service images. (use 'default' for using your default SSH Agent) \|
update docs generation to avoid man pages generation Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com> 2024-07-17 11:27:58 +02:00			\| `--with-dependencies` \| `bool` \| \| Also build dependencies (transitively) \|
docs: also generate "usage" in MarkDown files Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2022-03-09 12:57:07 +01:00

			`<!---MARKER_GEN_END-->`
update reference docs Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com> 2021-06-08 09:39:49 +02:00
			`## Description`

Fix docs on default build image name 150fd4b8cfa39726e68c12fc0fd45ac4e0f20c5f changed the default separator from _ to -, but the docker compose build docs still mention _. Signed-off-by: Sebastian Correa <43179146+sebastian-correa@users.noreply.github.com> 2024-03-20 03:06:45 +01:00			Services are built once and then tagged, by default as `project-service`.
update reference docs Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com> 2021-06-08 09:39:49 +02:00
			`If the Compose file specifies an`
docs: fix trailing whitespace from markdown and regenerate Trailing whitespace in Markdown can force line-breaks, which doesn't seem to be the intent on these; find . -type f -print0 \| xargs -0 perl -pi -e 's/ +$//' The trailing whitespace also can cause the YAML to go wonky (although the cli-docs-tool now takes that into account), and caused the "examples" section to be missed in the `docker compose pull` page (something we should fix in the tool). Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2022-03-09 13:24:09 +01:00			`[image](https://github.com/compose-spec/compose-spec/blob/master/spec.md#image) name,`
update reference docs Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com> 2021-06-08 09:39:49 +02:00			`the image is tagged with that name, substituting any variables beforehand. See`
			`[variable interpolation](https://github.com/compose-spec/compose-spec/blob/master/spec.md#interpolation).`

docs: fix trailing whitespace from markdown and regenerate Trailing whitespace in Markdown can force line-breaks, which doesn't seem to be the intent on these; find . -type f -print0 \| xargs -0 perl -pi -e 's/ +$//' The trailing whitespace also can cause the YAML to go wonky (although the cli-docs-tool now takes that into account), and caused the "examples" section to be missed in the `docker compose pull` page (something we should fix in the tool). Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2022-03-09 13:24:09 +01:00			If you change a service's `Dockerfile` or the contents of its build directory,
[v2] docs: markdown and link fixes Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2021-09-13 17:14:32 +02:00			run `docker compose build` to rebuild it.