Skip to content

Commit a7524f8

Browse files
crazy-maxcrazy-max
authored
Merge pull request #93 from crazy-max/fix-links
update links to docs
2 parents 1c7934b + f589b1f commit a7524f8

File tree

1 file changed

+25
-35
lines changed

1 file changed

+25
-35
lines changed

‎README.md

+25-35
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,14 @@
55

66
## :test_tube: Experimental
77

8-
This repository is considered **EXPERIMENTAL** and under active development until further notice. It is subject to
9-
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)
10-
of this action in your workflow (i.e `docker/[email protected]`).
8+
This repository is considered **EXPERIMENTAL** and under active development
9+
until further notice. It is subject to non-backward compatible changes or
10+
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)
11+
of this action in your workflow (i.e `docker/[email protected]`).
1112

1213
## About
1314

14-
GitHub Action to use Docker [Buildx Bake](https://github.com/docker/buildx/blob/master/docs/reference/buildx_bake.md)
15+
GitHub Action to use Docker [Buildx Bake](https://docs.docker.com/build/customize/bake/)
1516
as a high-level build command.
1617

1718
![Screenshot](.github/bake-action.png)
@@ -22,7 +23,7 @@ ___
2223
* [Customizing](#customizing)
2324
* [inputs](#inputs)
2425
* [outputs](#outputs)
25-
* [Keep up-to-date with GitHub Dependabot](#keep-up-to-date-with-github-dependabot)
26+
* [Contributing](#contributing)
2627

2728
## Usage
2829

@@ -52,7 +53,7 @@ jobs:
5253
password: ${{ secrets.DOCKERHUB_TOKEN }}
5354
-
5455
name: Build and push
55-
uses: docker/bake-action@master
56+
uses: docker/bake-action@v2
5657
with:
5758
push: true
5859
```
@@ -78,39 +79,28 @@ Following inputs can be used as `step.with` keys
7879
> targets: default,release
7980
> ```
8081

81-
| Name | Type | Description |
82-
|------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------|
83-
| `builder` | String | Builder instance (see [setup-buildx](https://github.com/docker/setup-buildx-action) action) |
84-
| `files` | List/CSV | List of [bake definition files](https://github.com/docker/buildx/blob/master/docs/reference/buildx_bake.md#file) |
85-
| `workdir` | String | Working directory of execution |
86-
| `targets` | List/CSV | List of bake targets (if empty, Buildx Bake will build target `default`) |
87-
| `no-cache` | Bool | Do not use cache when building the image (default `false`) |
88-
| `pull` | Bool | Always attempt to pull a newer version of the image (default `false`) |
89-
| `load` | Bool | Load is a shorthand for `--set=*.output=type=docker` (default `false`) |
90-
| `push` | Bool | Push is a shorthand for `--set=*.output=type=registry` (default `false`) |
91-
| `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`) |
92-
| `source` | String | [Remote bake definition](https://github.com/docker/buildx/blob/master/docs/guides/bake/file-definition.md#remote-definition) to build from |
82+
| Name | Type | Description |
83+
|------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
84+
| `builder` | String | Builder instance (see [setup-buildx](https://github.com/docker/setup-buildx-action) action) |
85+
| `files` | List/CSV | List of [bake definition files](https://docs.docker.com/build/customize/bake/file-definition/) |
86+
| `workdir` | String | Working directory of execution |
87+
| `targets` | List/CSV | List of bake targets (`default` target used if empty) |
88+
| `no-cache` | Bool | Do not use cache when building the image (default `false`) |
89+
| `pull` | Bool | Always attempt to pull a newer version of the image (default `false`) |
90+
| `load` | Bool | Load is a shorthand for `--set=*.output=type=docker` (default `false`) |
91+
| `push` | Bool | Push is a shorthand for `--set=*.output=type=registry` (default `false`) |
92+
| `set` | List | List of [targets values to override](https://docs.docker.com/engine/reference/commandline/buildx_bake/#set) (eg: `targetpattern.key=value`) |
93+
| `source` | String | [Remote bake definition](https://docs.docker.com/build/customize/bake/file-definition/#remote-definition) to build from |
9394

9495
### outputs
9596

9697
Following outputs are available
9798

98-
| Name | Type | Description |
99-
|-------------------|---------|---------------------------------------|
100-
| `metadata` | JSON | Build result metadata |
99+
| Name | Type | Description |
100+
|------------|------|-----------------------|
101+
| `metadata` | JSON | Build result metadata |
101102

102-
## Keep up-to-date with GitHub Dependabot
103+
## Contributing
103104

104-
Since [Dependabot](https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot)
105-
has [native GitHub Actions support](https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#package-ecosystem),
106-
to enable it on your GitHub repo all you need to do is add the `.github/dependabot.yml` file:
107-
108-
```yaml
109-
version: 2
110-
updates:
111-
# Maintain dependencies for GitHub Actions
112-
- package-ecosystem: "github-actions"
113-
directory: "/"
114-
schedule:
115-
interval: "daily"
116-
```
105+
Want to contribute? Awesome! You can find information about contributing to
106+
this project in the [CONTRIBUTING.md](/.github/CONTRIBUTING.md)

0 commit comments

Comments
 (0)