WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Commit d50a4f2

Browse files
committed
deprecate install input
Signed-off-by: CrazyMax <[email protected]>
1 parent 65d18f8 commit d50a4f2

File tree

3 files changed

+15
-22
lines changed

3 files changed

+15
-22
lines changed

.github/workflows/ci.yml

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -115,22 +115,6 @@ jobs:
115115
context: .
116116
platforms: linux/amd64,linux/arm64,linux/ppc64le
117117

118-
install:
119-
runs-on: ubuntu-latest
120-
steps:
121-
-
122-
name: Checkout
123-
uses: actions/checkout@v6
124-
-
125-
name: Set up Docker Buildx
126-
uses: ./
127-
with:
128-
install: true
129-
-
130-
name: Check cmd
131-
run: |
132-
docker build --help
133-
134118
use:
135119
runs-on: ubuntu-latest
136120
strategy:

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ The following inputs can be used as `step.with` keys:
9494
| `buildkitd-flags` | String | | [BuildKit daemon flags](https://docs.docker.com/engine/reference/commandline/buildx_create/#buildkitd-flags) |
9595
| `buildkitd-config` \* | String | | [BuildKit daemon config file](https://docs.docker.com/engine/reference/commandline/buildx_create/#config) |
9696
| `buildkitd-config-inline` \* | String | | Same as `buildkitd-config` but inline |
97-
| `install` | Bool | `false` | Sets up `docker build` command as an alias to `docker buildx` |
97+
| `install` \* | Bool | `false` | Sets up `docker build` command as an alias to `docker buildx` |
9898
| `use` | Bool | `true` | Switch to this builder instance |
9999
| `endpoint` | String | | [Optional address for docker socket](https://docs.docker.com/engine/reference/commandline/buildx_create/#description) or context from `docker context ls` |
100100
| `platforms` | List/CSV | | Fixed [platforms](https://docs.docker.com/engine/reference/commandline/buildx_create/#platform) for current node. If not empty, values take priority over the detected ones |
@@ -111,6 +111,14 @@ The following inputs can be used as `step.with` keys:
111111
> [!NOTE]
112112
> `buildkitd-config` and `buildkitd-config-inline` are mutually exclusive.
113113

114+
> [!NOTE]
115+
> `install` input is deprecated and will be removed in a future release. This
116+
> input is not necessary when building with our actions like
117+
> `docker/build-push-action` or `docker/bake-action`. If you are still building
118+
> with the `docker build` command then you can set the `BUILDX_BUILDER`
119+
> environment variable, or you can just directly invoke the
120+
> `docker buildx build` command: https://github.com/docker/setup-buildx-action/pull/455
121+
114122
### outputs
115123

116124
The following outputs are available:

action.yml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,6 @@ inputs:
2626
buildkitd-config-inline:
2727
description: 'Inline BuildKit daemon config'
2828
required: false
29-
install:
30-
description: 'Sets up docker build command as an alias to docker buildx build'
31-
default: 'false'
32-
required: false
3329
use:
3430
description: 'Switch to this builder instance'
3531
default: 'true'
@@ -58,7 +54,7 @@ inputs:
5854
description: 'Cleanup temp files and remove builder at the end of a job'
5955
default: 'true'
6056
required: false
61-
# TODO: remove deprecated config and config-inline inputs
57+
# TODO: remove deprecated config, config-inline and install inputs
6258
config:
6359
description: 'BuildKit daemon config file'
6460
deprecationMessage: 'Use buildkitd-config instead'
@@ -67,6 +63,11 @@ inputs:
6763
description: 'Inline BuildKit daemon config'
6864
deprecationMessage: 'Use buildkitd-config-inline instead'
6965
required: false
66+
install:
67+
description: 'Sets up docker build command as an alias to docker buildx build'
68+
deprecationMessage: '"docker buildx install" command is deprecated and will be removed in a future release, use BUILDX_BUILDER environment variable instead'
69+
default: 'false'
70+
required: false
7071

7172
outputs:
7273
name:

0 commit comments

Comments
 (0)