diff --git a/README.md b/README.md index a96f6b6..406bb8f 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,14 @@ ## :test_tube: Experimental -This repository is considered **EXPERIMENTAL** and under active development until further notice. It is subject to -non-backward compatible changes or removal in any future version so you should [pin to a specific tag/commit](https://docs.github.com/en/actions/creating-actions/about-actions#using-tags-for-release-management) -of this action in your workflow (i.e `docker/bake-action@v1.1.3`). +This repository is considered **EXPERIMENTAL** and under active development +until further notice. It is subject to non-backward compatible changes or +removal in any future version, so you should [pin to a specific tag/commit](https://docs.github.com/en/actions/creating-actions/about-actions#using-tags-for-release-management) +of this action in your workflow (i.e `docker/bake-action@v1.1.3`). ## About -GitHub Action to use Docker [Buildx Bake](https://github.com/docker/buildx/blob/master/docs/reference/buildx_bake.md) +GitHub Action to use Docker [Buildx Bake](https://docs.docker.com/build/customize/bake/) as a high-level build command. ![Screenshot](.github/bake-action.png) @@ -22,7 +23,7 @@ ___ * [Customizing](#customizing) * [inputs](#inputs) * [outputs](#outputs) -* [Keep up-to-date with GitHub Dependabot](#keep-up-to-date-with-github-dependabot) +* [Contributing](#contributing) ## Usage @@ -52,7 +53,7 @@ jobs: password: ${{ secrets.DOCKERHUB_TOKEN }} - name: Build and push - uses: docker/bake-action@master + uses: docker/bake-action@v2 with: push: true ``` @@ -78,39 +79,28 @@ Following inputs can be used as `step.with` keys > targets: default,release > ``` -| Name | Type | Description | -|------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------| -| `builder` | String | Builder instance (see [setup-buildx](https://github.com/docker/setup-buildx-action) action) | -| `files` | List/CSV | List of [bake definition files](https://github.com/docker/buildx/blob/master/docs/reference/buildx_bake.md#file) | -| `workdir` | String | Working directory of execution | -| `targets` | List/CSV | List of bake targets (if empty, Buildx Bake will build target `default`) | -| `no-cache` | Bool | Do not use cache when building the image (default `false`) | -| `pull` | Bool | Always attempt to pull a newer version of the image (default `false`) | -| `load` | Bool | Load is a shorthand for `--set=*.output=type=docker` (default `false`) | -| `push` | Bool | Push is a shorthand for `--set=*.output=type=registry` (default `false`) | -| `set` | List | List of [targets values to override](https://github.com/docker/buildx/blob/master/docs/reference/buildx_bake.md#set) (eg: `targetpattern.key=value`) | -| `source` | String | [Remote bake definition](https://github.com/docker/buildx/blob/master/docs/guides/bake/file-definition.md#remote-definition) to build from | +| Name | Type | Description | +|------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------| +| `builder` | String | Builder instance (see [setup-buildx](https://github.com/docker/setup-buildx-action) action) | +| `files` | List/CSV | List of [bake definition files](https://docs.docker.com/build/customize/bake/file-definition/) | +| `workdir` | String | Working directory of execution | +| `targets` | List/CSV | List of bake targets (`default` target used if empty) | +| `no-cache` | Bool | Do not use cache when building the image (default `false`) | +| `pull` | Bool | Always attempt to pull a newer version of the image (default `false`) | +| `load` | Bool | Load is a shorthand for `--set=*.output=type=docker` (default `false`) | +| `push` | Bool | Push is a shorthand for `--set=*.output=type=registry` (default `false`) | +| `set` | List | List of [targets values to override](https://docs.docker.com/engine/reference/commandline/buildx_bake/#set) (eg: `targetpattern.key=value`) | +| `source` | String | [Remote bake definition](https://docs.docker.com/build/customize/bake/file-definition/#remote-definition) to build from | ### outputs Following outputs are available -| Name | Type | Description | -|-------------------|---------|---------------------------------------| -| `metadata` | JSON | Build result metadata | +| Name | Type | Description | +|------------|------|-----------------------| +| `metadata` | JSON | Build result metadata | -## Keep up-to-date with GitHub Dependabot +## Contributing -Since [Dependabot](https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot) -has [native GitHub Actions support](https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#package-ecosystem), -to enable it on your GitHub repo all you need to do is add the `.github/dependabot.yml` file: - -```yaml -version: 2 -updates: - # Maintain dependencies for GitHub Actions - - package-ecosystem: "github-actions" - directory: "/" - schedule: - interval: "daily" -``` +Want to contribute? Awesome! You can find information about contributing to +this project in the [CONTRIBUTING.md](/.github/CONTRIBUTING.md)