mirror of
https://github.com/docker/build-push-action.git
synced 2024-11-29 03:30:59 -05:00
docs: named contexts
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
This commit is contained in:
parent
6a6e8c7c14
commit
0f5a7d48d5
3 changed files with 100 additions and 75 deletions
|
@ -28,6 +28,7 @@ ___
|
||||||
* [Export image to Docker](docs/advanced/export-docker.md)
|
* [Export image to Docker](docs/advanced/export-docker.md)
|
||||||
* [Share built image between jobs](docs/advanced/share-image-jobs.md)
|
* [Share built image between jobs](docs/advanced/share-image-jobs.md)
|
||||||
* [Test your image before pushing it](docs/advanced/test-before-push.md)
|
* [Test your image before pushing it](docs/advanced/test-before-push.md)
|
||||||
|
* [Named contexts](docs/advanced/named-contexts.md)
|
||||||
* [Handle tags and labels](docs/advanced/tags-labels.md)
|
* [Handle tags and labels](docs/advanced/tags-labels.md)
|
||||||
* [Update DockerHub repo description](docs/advanced/dockerhub-desc.md)
|
* [Update DockerHub repo description](docs/advanced/dockerhub-desc.md)
|
||||||
* [Customizing](#customizing)
|
* [Customizing](#customizing)
|
||||||
|
@ -176,6 +177,7 @@ jobs:
|
||||||
* [Export image to Docker](docs/advanced/export-docker.md)
|
* [Export image to Docker](docs/advanced/export-docker.md)
|
||||||
* [Share built image between jobs](docs/advanced/share-image-jobs.md)
|
* [Share built image between jobs](docs/advanced/share-image-jobs.md)
|
||||||
* [Test your image before pushing it](docs/advanced/test-before-push.md)
|
* [Test your image before pushing it](docs/advanced/test-before-push.md)
|
||||||
|
* [Named contexts](docs/advanced/named-contexts.md)
|
||||||
* [Handle tags and labels](docs/advanced/tags-labels.md)
|
* [Handle tags and labels](docs/advanced/tags-labels.md)
|
||||||
* [Update DockerHub repo description](docs/advanced/dockerhub-desc.md)
|
* [Update DockerHub repo description](docs/advanced/dockerhub-desc.md)
|
||||||
|
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
# Export image to Docker
|
# Export image to Docker
|
||||||
|
|
||||||
You may want your build result to be available in the Docker client through `docker images` to be able to use it
|
You may want your build result to be available in the Docker client through
|
||||||
in another step of your workflow:
|
`docker images` to be able to use it in another step of your workflow:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
name: ci
|
name: ci
|
||||||
|
@ -33,75 +33,3 @@ jobs:
|
||||||
run: |
|
run: |
|
||||||
docker image inspect myimage:latest
|
docker image inspect myimage:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## Usage of the built image in other build steps
|
|
||||||
|
|
||||||
[By default](https://github.com/docker/setup-buildx-action#customizing), `docker/setup-buildx-action@v2`
|
|
||||||
uses `docker-container` as a build driver, so the docker images are not available in the builder container.
|
|
||||||
To use them, you may use [build contexts](https://github.com/docker/buildx/blob/master/docs/reference/buildx_build.md#-additional-build-contexts---build-context):
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
name: ci
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- 'main'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
docker:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
-
|
|
||||||
name: Checkout
|
|
||||||
uses: actions/checkout@v3
|
|
||||||
-
|
|
||||||
name: Set up Docker Buildx
|
|
||||||
uses: docker/setup-buildx-action@v2
|
|
||||||
-
|
|
||||||
name: Build base image
|
|
||||||
uses: docker/build-push-action@v3
|
|
||||||
with:
|
|
||||||
context: base
|
|
||||||
load: true
|
|
||||||
tags: my-base-image:latest
|
|
||||||
-
|
|
||||||
name: Build image from my-base-image:latest
|
|
||||||
uses: docker/build-push-action@v3
|
|
||||||
with:
|
|
||||||
context: .
|
|
||||||
build-contexts: |
|
|
||||||
base-image=docker-image://my-base-image:latest
|
|
||||||
tags: myimage:latest
|
|
||||||
```
|
|
||||||
|
|
||||||
Where `base-image`is the name of the base image (or stage name if specified) in your Dockerfile:
|
|
||||||
```Dockerfile
|
|
||||||
FROM base-image
|
|
||||||
```
|
|
||||||
|
|
||||||
### Bake alternative
|
|
||||||
|
|
||||||
You may also want to use [bake](https://docs.docker.com/build/bake/build-contexts/#using-a-result-of-one-target-as-a-base-image-in-another-target)
|
|
||||||
and build the base image and the target image in one build step:
|
|
||||||
```terraform
|
|
||||||
# docker-bake.hcl
|
|
||||||
target "base" {
|
|
||||||
dockerfile = "baseapp.Dockerfile"
|
|
||||||
}
|
|
||||||
|
|
||||||
target "app" {
|
|
||||||
contexts = {
|
|
||||||
baseapp = "target:base"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
-
|
|
||||||
name: Build
|
|
||||||
uses: docker/bake-action@v2
|
|
||||||
with:
|
|
||||||
target: app
|
|
||||||
```
|
|
||||||
|
|
95
docs/advanced/named-contexts.md
Normal file
95
docs/advanced/named-contexts.md
Normal file
|
@ -0,0 +1,95 @@
|
||||||
|
# Named contexts
|
||||||
|
|
||||||
|
You can define [additional build contexts](https://docs.docker.com/engine/reference/commandline/buildx_build/#build-context)
|
||||||
|
that can be accessed in your Dockerfile with `FROM name` or `--from=name`. When
|
||||||
|
Dockerfile defines a stage with the same name it is overwritten.
|
||||||
|
|
||||||
|
This can be useful with GitHub Actions to reuse results from other builds or
|
||||||
|
pin an image to a spcific tag in your workflow.
|
||||||
|
|
||||||
|
## Pin image to a specific tag
|
||||||
|
|
||||||
|
Replace `alpine:latest` with a pinned one:
|
||||||
|
|
||||||
|
```dockerfile
|
||||||
|
# syntax=docker/dockerfile:1
|
||||||
|
FROM alpine
|
||||||
|
RUN echo "Hello World"
|
||||||
|
```
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
name: ci
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- 'main'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
docker:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
-
|
||||||
|
name: Checkout
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
-
|
||||||
|
name: Set up Docker Buildx
|
||||||
|
uses: docker/setup-buildx-action@v2
|
||||||
|
-
|
||||||
|
name: Build
|
||||||
|
uses: docker/build-push-action@v3
|
||||||
|
with:
|
||||||
|
context: .
|
||||||
|
build-contexts: |
|
||||||
|
alpine=docker-image://alpine:3.16
|
||||||
|
tags: myimage:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage of the built image in other build steps
|
||||||
|
|
||||||
|
By default, the [`setup-buildx` action](https://github.com/docker/setup-buildx-action#about)
|
||||||
|
uses `docker-container` as a build driver, so built Docker images are not
|
||||||
|
available in the builder container.
|
||||||
|
|
||||||
|
With named contexts you can reuse the built image:
|
||||||
|
|
||||||
|
```dockerfile
|
||||||
|
# syntax=docker/dockerfile:1
|
||||||
|
FROM alpine
|
||||||
|
RUN echo "Hello World"
|
||||||
|
```
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
name: ci
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- 'main'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
docker:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
-
|
||||||
|
name: Checkout
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
-
|
||||||
|
name: Set up Docker Buildx
|
||||||
|
uses: docker/setup-buildx-action@v2
|
||||||
|
-
|
||||||
|
name: Build base image
|
||||||
|
uses: docker/build-push-action@v3
|
||||||
|
with:
|
||||||
|
context: base
|
||||||
|
load: true
|
||||||
|
tags: my-base-image:latest
|
||||||
|
-
|
||||||
|
name: Build
|
||||||
|
uses: docker/build-push-action@v3
|
||||||
|
with:
|
||||||
|
context: .
|
||||||
|
build-contexts: |
|
||||||
|
alpine=docker-image://my-base-image:latest
|
||||||
|
tags: myimage:latest
|
||||||
|
```
|
Loading…
Reference in a new issue