Skip to content

Commit

Permalink
Handle build bake through bake, bake-files and bake-targets
Browse files Browse the repository at this point in the history
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
  • Loading branch information
CrazyMax committed Aug 16, 2020
1 parent b07bd1f commit 8be103f
Show file tree
Hide file tree
Showing 9 changed files with 475 additions and 241 deletions.
44 changes: 44 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,48 @@ jobs:
localhost:5000/name/app:1.0.0
-
name: Dump context
if: always()
uses: crazy-max/ghaction-dump-context@v1

bake:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
target:
- default
- release
steps:
-
name: Run local registry
run: |
docker run -d -p 5000:5000 registry:2
-
name: Checkout
uses: actions/checkout@v2.3.1
-
name: Set up QEMU
uses: ./setup-qemu/ # change to docker/setup-qemu-action@master
with:
platforms: all
-
name: Set up Docker Buildx
id: buildx
uses: ./setup-buildx/ # change to docker/setup-buildx-action@master
# with:
# driver-opt: network=host
-
name: Build and push
uses: ./
with:
builder: ${{ steps.buildx.outputs.name }}
bake: true
#push: true
bake-files: |
./test/config.hcl
bake-targets: |
${{ matrix.target }}
-
name: Dump context
if: always()
uses: crazy-max/ghaction-dump-context@v1
78 changes: 67 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,59 @@ jobs:
user/app:1.0.0
```
### Bake
[Buildx bake](https://github.com/docker/buildx#buildx-bake-options-target) is also available with this action through
the [`bake` inputs](#inputs).

```yaml
name: ci
on:
pull_request:
branches: master
push:
branches: master
tags:
jobs:
buildx:
runs-on: ubuntu-latest
steps:
-
name: Checkout
uses: actions/checkout@v2
-
name: Set up QEMU
uses: docker/setup-qemu-action@v1
with:
platforms: all
-
name: Set up Docker Buildx
id: buildx
uses: docker/setup-buildx-action@v1
with:
install: true
-
name: Login to DockerHub
uses: docker/login-action@v1
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
-
name: Build and push
uses: docker/build-push-action@v2
with:
builder: ${{ steps.buildx.outputs.name }}
push: true
bake: true
bake-files: |
./config.hcl
bake-targets: |
default
release
```

## Customizing

### inputs
Expand All @@ -74,22 +127,25 @@ Following inputs can be used as `step.with` keys

| Name | Type | Default | Description |
|---------------------|---------|-----------------------------------|------------------------------------|
| `builder` | String | | Builder instance |
| `builder` | String | | Builder instance (see [setup-buildx](https://github.com/docker/setup-buildx-action) action) |
| `context` | String | `.` | Build's context is the set of files located in the specified `PATH` or `URL` |
| `file` | String | `./Dockerfile` | Path to the Dockerfile. |
| `build-args` | String | | Newline-delimited list of build-time variables |
| `labels` | String | | Newline-delimited list of metadata for an image |
| `tags` | String | | Newline-delimited list of tags **required** |
| `build-args` | List | | Newline-delimited list of build-time variables |
| `labels` | List | | Newline-delimited list of metadata for an image |
| `tags` | List | | Newline-delimited list of tags |
| `pull` | Bool | `false` | Always attempt to pull a newer version of the image |
| `target` | String | | Sets the target stage to build |
| `allow` | String | | Allow extra privileged entitlement (eg. network.host,security.insecure) |
| `allow` | String | | [Allow](https://github.com/docker/buildx#--allowentitlement) extra privileged entitlement (eg. network.host,security.insecure) |
| `no-cache` | Bool | `false` | Do not use cache when building the image |
| `platforms` | String | | Comma-delimited list of target platforms for build |
| `load` | Bool | `false` | Shorthand for `--output=type=docker` |
| `push` | Bool | `false` | Shorthand for `--output=type=registry` |
| `outputs` | String | | Newline-delimited list of output destinations (format: `type=local,dest=path`) |
| `cache-from` | String | | Newline-delimited list of external cache sources (eg. `user/app:cache`, `type=local,src=path/to/dir`) |
| `cache-to` | String | | Newline-delimited list of cache export destinations (eg. `user/app:cache`, `type=local,dest=path/to/dir`) |
| `platforms` | String | | Comma-delimited list of [target platforms](https://github.com/docker/buildx#---platformvaluevalue) for build |
| `load` | Bool | `false` | [Load](https://github.com/docker/buildx#--load) is a shorthand for `--output=type=docker` |
| `push` | Bool | `false` | [Push](https://github.com/docker/buildx#--push) is a shorthand for `--output=type=registry` |
| `outputs` | List | | Newline-delimited list of [output destinations](https://github.com/docker/buildx#-o---outputpath-typetypekeyvalue) (format: `type=local,dest=path`) |
| `cache-from` | List | | Newline-delimited list of [external cache sources](https://github.com/docker/buildx#--cache-fromnametypetypekeyvalue) (eg. `user/app:cache`, `type=local,src=path/to/dir`) |
| `cache-to` | List | | Newline-delimited list of [cache export destinations](https://github.com/docker/buildx#--cache-tonametypetypekeyvalue) (eg. `user/app:cache`, `type=local,dest=path/to/dir`) |
| `bake` | Bool | `false` | Use [bake](https://github.com/docker/buildx#buildx-bake-options-target) as the high-level build command |
| `bake-files` | List | | Newline-delimited list of [bake definition files](https://github.com/docker/buildx#file-definition) |
| `bake-targets` | List | | Newline-delimited list of bake targets |

### outputs

Expand Down
16 changes: 13 additions & 3 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ inputs:
required: false
tags:
description: "Newline-delimited list of tags"
required: true
required: false
pull:
description: "Always attempt to pull a newer version of the image"
required: false
Expand All @@ -44,11 +44,11 @@ inputs:
description: "Comma-delimited list of target platforms for build"
required: false
load:
description: "Shorthand for --output=type=docker"
description: "Load is a shorthand for --output=type=docker"
required: false
default: 'false'
push:
description: "Shorthand for --output=type=registry"
description: "Push is a shorthand for --output=type=registry"
required: false
default: 'false'
outputs:
Expand All @@ -60,6 +60,16 @@ inputs:
cache-to:
description: "Newline-delimited list of cache export destinations for buildx (eg. user/app:cache, type=local,dest=path/to/dir)"
required: false
bake:
description: "Use bake as the high-level build command"
required: false
default: 'false'
bake-files:
description: "Newline-delimited list of bake definition files"
required: false
bake-targets:
description: "Newline-delimited list of bake targets"
required: false

outputs:
digest:
Expand Down
Loading

0 comments on commit 8be103f

Please sign in to comment.