Skip to content

Commit

Permalink
Merge pull request #189 from docker/version-pinning-docs
Browse files Browse the repository at this point in the history
docs: add version pinning information to the README
  • Loading branch information
crazy-max committed Jan 25, 2023
2 parents 165fe68 + 70deadb commit 7932f62
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ ___

* [Usage](#usage)
* [Configuring your builder](#configuring-your-builder)
* [Version pinning](#version-pinning)
* [Customizing](#customizing)
* [inputs](#inputs)
* [outputs](#outputs)
Expand Down Expand Up @@ -58,6 +59,33 @@ jobs:

See https://docs.docker.com/build/ci/github-actions/configure-builder/

## Version pinning

This action builds images using [Buildx](https://github.com/docker/buildx) and
[BuildKit](https://github.com/moby/buildkit). By default, the action will
attempt to use the latest version of Buildx available on the GitHub Runner
(the build client) and the latest release of BuildKit (the build server).

To pin to a specific version of Buildx, use the `version` input. For example,
to pin to Buildx v0.10.0:

```yaml
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
with:
version: v0.10.0
```

To pin to a specific version of BuildKit, use the `image` option in the
`driver-opts` input. For example, to pin to BuildKit v0.11.0:

```yaml
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
with:
driver-opts: image=moby/buildkit:v0.11.0
```

## Customizing

### inputs
Expand Down

0 comments on commit 7932f62

Please sign in to comment.