Skip to content

Commit 26d2041

Browse files
authored
chore(vale): build fixes (#23277)
1 parent f5a8c24 commit 26d2041

File tree

17 files changed

+83
-58
lines changed

17 files changed

+83
-58
lines changed

.vale.ini

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,19 @@ Docker.Capitalization = NO
1313
Vale.Spelling = NO
1414
Vale.Terms = NO
1515
Docker.Capitalization = NO
16+
Docker.We = NO
17+
18+
[content/manuals/build/buildkit/dockerfile-release-notes.md]
19+
Vale.Spelling = NO
20+
Vale.Terms = NO
21+
Docker.Capitalization = NO
22+
Docker.We = NO
23+
24+
[content/manuals/*/release-notes.md]
25+
Vale.Spelling = NO
26+
Vale.Terms = NO
27+
Docker.Capitalization = NO
28+
Docker.We = NO
1629

1730
[content/contribute/*.md]
1831
Vale.Spelling = NO

_vale/config/vocabularies/Docker/accept.txt

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,15 @@ bootup
1414
Btrfs
1515
Bugsnag
1616
BuildKit
17+
buildkitd
1718
BusyBox
1819
CentOS
1920
Ceph
2021
cgroup
2122
Chrome
2223
Chrome DevTools
23-
Citrix
2424
CI/CD
25+
Citrix
2526
cli
2627
CLI
2728
CloudFront
@@ -39,7 +40,6 @@ denylist
3940
deprovisioning
4041
deserialization
4142
deserialize
42-
[Dd]ev
4343
Dev Environments?
4444
Dex
4545
displayName
@@ -59,6 +59,7 @@ Docker's
5959
Dockerfile
6060
dockerignore
6161
Dockerize
62+
Dockerized
6263
Dockerizing
6364
Entra
6465
EPERM
@@ -129,6 +130,7 @@ netfilter
129130
netlabel
130131
netlink
131132
Netplan
133+
Neovim
132134
NFSv\d
133135
Nginx
134136
npm
@@ -142,9 +144,10 @@ osquery
142144
osxfs
143145
OTel
144146
Paketo
147+
perl
145148
pgAdmin
146-
plist
147149
PKG
150+
plist
148151
Postgres
149152
PowerShell
150153
Python
@@ -173,8 +176,8 @@ subvolume
173176
Syft
174177
syntaxes
175178
Sysbox
176-
sysctls
177179
sysctl
180+
sysctls
178181
Sysdig
179182
systemd
180183
Testcontainers
@@ -184,8 +187,6 @@ Trivy
184187
Trixie
185188
Ubuntu
186189
ufw
187-
ui
188-
uid
189190
umask
190191
uncaptured
191192
Uncaptured
@@ -203,6 +204,7 @@ Windows
203204
windowsfilter
204205
WireMock
205206
workdir
207+
WORKDIR
206208
Xdebug
207209
youki
208210
Yubikey
@@ -219,6 +221,8 @@ Zsh
219221
[Cc]odenames?
220222
[Cc]ompose
221223
[Cc]onfigs
224+
[dD]eduplicate
225+
[Dd]ev
222226
[Dd]istroless
223227
[Ff]ilepaths?
224228
[Ff]iletypes?

content/manuals/build/bake/variables.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Variables in Bake
33
linkTitle: Variables
44
weight: 40
5-
description:
5+
description:
66
keywords: build, buildx, bake, buildkit, hcl, variables
77
---
88

@@ -93,7 +93,7 @@ range, or other condition, you can define custom validation rules using the
9393
`validation` block.
9494

9595
In the following example, validation is used to enforce a numeric constraint on
96-
a variable value; the `PORT` variable must be 1024 or higher.
96+
a variable value; the `PORT` variable must be 1024 or greater.
9797

9898
```hcl {title=docker-bake.hcl}
9999
# Define a variable `PORT` with a default value and a validation rule
@@ -103,7 +103,7 @@ variable "PORT" {
103103
# Validation block to ensure `PORT` is a valid number within the acceptable range
104104
validation {
105105
condition = PORT >= 1024 # Ensure `PORT` is at least 1024
106-
error_message = "The variable 'PORT' must be 1024 or higher." # Error message for invalid values
106+
error_message = "The variable 'PORT' must be 1024 or greater." # Error message for invalid values
107107
}
108108
}
109109
```

content/manuals/build/building/best-practices.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -259,8 +259,8 @@ to create an efficient and maintainable Dockerfile.
259259

260260
> [!TIP]
261261
>
262-
> Want a better editing experience for Dockerfiles in VS Code?
263-
> Check out the [Docker VS Code Extension (Beta)](https://marketplace.visualstudio.com/items?itemName=docker.docker) for linting, code navigation, and vulnerability scanning.
262+
> To improve linting, code navigation, and vulnerability scanning of your Dockerfiles in Visual Studio Code
263+
> see [Docker VS Code Extension](https://marketplace.visualstudio.com/items?itemName=docker.docker).
264264
265265
### FROM
266266

@@ -487,7 +487,7 @@ service, such as Apache and Rails, you would run something like `CMD
487487
for any service-based image.
488488
489489
In most other cases, `CMD` should be given an interactive shell, such as bash,
490-
python and perl. For example, `CMD ["perl", "-de0"]`, `CMD ["python"]`, or `CMD
490+
Python and perl. For example, `CMD ["perl", "-de0"]`, `CMD ["python"]`, or `CMD
491491
["php", "-a"]`. Using this form means that when you execute something like
492492
`docker run -it python`, you’ll get dropped into a usable shell, ready to go.
493493
`CMD` should rarely be used in the manner of `CMD ["param", "param"]` in
@@ -556,7 +556,7 @@ $ docker run --rm test sh -c 'echo $ADMIN_USER'
556556
mark
557557
```
558558

559-
To prevent this, and really unset the environment variable, use a `RUN` command
559+
To prevent this and unset the environment variable, use a `RUN` command
560560
with shell commands, to set, use, and unset the variable all in a single layer.
561561
You can separate your commands with `;` or `&&`. If you use the second method,
562562
and one of the commands fails, the `docker build` also fails. This is usually a
@@ -763,7 +763,7 @@ RUN groupadd -r postgres && useradd --no-log-init -r -g postgres postgres
763763
> with a significantly large UID inside a Docker container can lead to disk
764764
> exhaustion because `/var/log/faillog` in the container layer is filled with
765765
> NULL (\0) characters. A workaround is to pass the `--no-log-init` flag to
766-
> useradd. The Debian/Ubuntu `adduser` wrapper does not support this flag.
766+
> `useradd`. The Debian/Ubuntu `adduser` wrapper does not support this flag.
767767
768768
Avoid installing or using `sudo` as it has unpredictable TTY and
769769
signal-forwarding behavior that can cause problems. If you absolutely need
@@ -778,11 +778,11 @@ For more information about `USER`, see [Dockerfile reference for the USER instru
778778
### WORKDIR
779779

780780
For clarity and reliability, you should always use absolute paths for your
781-
`WORKDIR`. Also, you should use `WORKDIR` instead of proliferating instructions
781+
`WORKDIR`. Also, you should use `WORKDIR` instead of proliferating instructions
782782
like `RUN cd … && do-something`, which are hard to read, troubleshoot, and
783783
maintain.
784784

785-
For more information about `WORKDIR`, see [Dockerfile reference for the WORKDIR instruction](/reference/dockerfile.md#workdir).
785+
For more information about `WORKDIR`, see [Dockerfile reference for the `WORKDIR` instruction](/reference/dockerfile.md#workdir).
786786

787787
### ONBUILD
788788

@@ -802,7 +802,7 @@ Dockerfile, as you can see in [Ruby’s `ONBUILD` variants](https://github.com/d
802802
Images built with `ONBUILD` should get a separate tag. For example,
803803
`ruby:1.9-onbuild` or `ruby:2.0-onbuild`.
804804

805-
Be careful when putting `ADD` or `COPY` in `ONBUILD`. The onbuild image
805+
Be careful when putting `ADD` or `COPY` in `ONBUILD`. The `onbuild image
806806
fails catastrophically if the new build's context is missing the resource being
807807
added. Adding a separate tag, as recommended above, helps mitigate this by
808808
allowing the Dockerfile author to make a choice.

content/manuals/build/buildkit/_index.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,9 @@ Apart from many new features, the main areas BuildKit improves on the current
2929
experience are performance, storage management, and extensibility. From the
3030
performance side, a significant update is a new fully concurrent build graph
3131
solver. It can run build steps in parallel when possible and optimize out
32-
commands that don't have an impact on the final result. We have also optimized
33-
the access to the local source files. By tracking only the updates made to these
32+
commands that don't have an impact on the final result.
33+
The access to the local source files has also been optimized. By tracking
34+
only the updates made to these
3435
files between repeated build invocations, there is no need to wait for local
3536
files to be read or uploaded before the work can begin.
3637

@@ -39,7 +40,7 @@ files to be read or uploaded before the work can begin.
3940
At the core of BuildKit is a
4041
[Low-Level Build (LLB)](https://github.com/moby/buildkit#exploring-llb) definition format. LLB is an intermediate binary format
4142
that allows developers to extend BuildKit. LLB defines a content-addressable
42-
dependency graph that can be used to put together very complex build
43+
dependency graph that can be used to put together complex build
4344
definitions. It also supports features not exposed in Dockerfiles, like direct
4445
data mounting and nested invocation.
4546

@@ -115,7 +116,7 @@ daemon.
115116
116117
BuildKit has experimental support for Windows containers (WCOW) as of version 0.13.
117118
This section walks you through the steps for trying it out.
118-
We appreciate any feedback you submit by [opening an issue here](https://github.com/moby/buildkit/issues/new), especially `buildkitd.exe`.
119+
To share feedback, [open an issue in the repository](https://github.com/moby/buildkit/issues/new), especially `buildkitd.exe`.
119120

120121
### Known limitations
121122

content/manuals/build/checks.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ Build checks are useful for:
3838

3939
> [!TIP]
4040
>
41-
> Want a better editing experience for Dockerfiles in VS Code?
42-
> Check out the [Docker VS Code Extension (Beta)](https://marketplace.visualstudio.com/items?itemName=docker.docker) for linting, code navigation, and vulnerability scanning.
41+
> To improve linting, code navigation, and vulnerability scanning of your Dockerfiles in Visual Studio Code
42+
> see [Docker VS Code Extension](https://marketplace.visualstudio.com/items?itemName=docker.docker).
4343
4444
## Build with checks
4545

content/manuals/build/ci/github-actions/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The following GitHub Actions are available:
2929
- [Docker Setup Compose](https://github.com/marketplace/actions/docker-setup-compose):
3030
installs and sets up [Compose](../../../compose).
3131
- [Docker Setup Docker](https://github.com/marketplace/actions/docker-setup-docker):
32-
installs Docker CE.
32+
installs Docker Engine.
3333
- [Docker Setup QEMU](https://github.com/marketplace/actions/docker-setup-qemu):
3434
installs [QEMU](https://github.com/qemu/qemu) static binaries for
3535
multi-platform builds.

content/manuals/build/ci/github-actions/cache.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ jobs:
3737

3838
- name: Set up Docker Buildx
3939
uses: docker/setup-buildx-action@v3
40-
40+
4141
- name: Build and push
4242
uses: docker/build-push-action@v6
4343
with:
@@ -67,10 +67,10 @@ jobs:
6767
with:
6868
username: ${{ vars.DOCKERHUB_USERNAME }}
6969
password: ${{ secrets.DOCKERHUB_TOKEN }}
70-
70+
7171
- name: Set up Docker Buildx
7272
uses: docker/setup-buildx-action@v3
73-
73+
7474
- name: Build and push
7575
uses: docker/build-push-action@v6
7676
with:
@@ -108,10 +108,10 @@ jobs:
108108
with:
109109
username: ${{ vars.DOCKERHUB_USERNAME }}
110110
password: ${{ secrets.DOCKERHUB_TOKEN }}
111-
111+
112112
- name: Set up Docker Buildx
113113
uses: docker/setup-buildx-action@v3
114-
114+
115115
- name: Build and push
116116
uses: docker/build-push-action@v6
117117
with:
@@ -124,47 +124,47 @@ jobs:
124124
> [!IMPORTANT]
125125
>
126126
> Starting [April 15th, 2025, only GitHub Cache service API v2 will be supported](https://gh.io/gha-cache-sunset).
127-
>
127+
>
128128
> If you encounter the following error during your build:
129-
>
129+
>
130130
> ```console
131131
> ERROR: failed to solve: This legacy service is shutting down, effective April 15, 2025. Migrate to the new service ASAP. For more information: https://gh.io/gha-cache-sunset
132132
> ```
133-
>
133+
>
134134
> You're probably using outdated tools that only support the legacy GitHub
135135
> Cache service API v1. Here are the minimum versions you need to upgrade to
136136
> depending on your use case:
137137
> * Docker Buildx >= v0.21.0
138138
> * BuildKit >= v0.20.0
139139
> * Docker Compose >= v2.33.1
140140
> * Docker Engine >= v28.0.0 (if you're building using the Docker driver with containerd image store enabled)
141-
>
141+
>
142142
> If you're building using the `docker/build-push-action` or `docker/bake-action`
143143
> actions on GitHub hosted runners, Docker Buildx and BuildKit are already up
144144
> to date but on self-hosted runners, you may need to update them yourself.
145145
> Alternatively, you can use the `docker/setup-buildx-action` action to install
146146
> the latest version of Docker Buildx:
147-
>
147+
>
148148
> ```yaml
149149
> - name: Set up Docker Buildx
150150
> uses: docker/setup-buildx-action@v3
151151
> with:
152152
> version: latest
153153
> ```
154-
>
154+
>
155155
> If you're building using Docker Compose, you can use the
156156
> `docker/setup-compose-action` action:
157-
>
157+
>
158158
> ```yaml
159159
> - name: Set up Docker Compose
160160
> uses: docker/setup-compose-action@v1
161161
> with:
162162
> version: latest
163163
> ```
164-
>
164+
>
165165
> If you're building using the Docker Engine with the containerd image store
166166
> enabled, you can use the `docker/setup-docker-action` action:
167-
>
167+
>
168168
> ```yaml
169169
> -
170170
> name: Set up Docker
@@ -182,7 +182,7 @@ jobs:
182182
### Cache mounts
183183

184184
BuildKit doesn't preserve cache mounts in the GitHub Actions cache by default.
185-
If you wish to put your cache mounts into GitHub Actions cache and reuse it
185+
To put your cache mounts into GitHub Actions cache and reuse it
186186
between builds, you can use a workaround provided by
187187
[`reproducible-containers/buildkit-cache-dance`](https://github.com/reproducible-containers/buildkit-cache-dance).
188188

@@ -224,7 +224,7 @@ jobs:
224224
with:
225225
username: ${{ vars.DOCKERHUB_USERNAME }}
226226
password: ${{ secrets.DOCKERHUB_TOKEN }}
227-
227+
228228
- name: Set up QEMU
229229
uses: docker/setup-qemu-action@v3
230230

content/manuals/build/concepts/context.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -498,6 +498,7 @@ The following code snippet shows an example `.dockerignore` file.
498498
*/*/temp*
499499
temp?
500500
```
501+
<!-- vale off -->
501502

502503
This file causes the following build behavior:
503504

@@ -508,6 +509,8 @@ This file causes the following build behavior:
508509
| `*/*/temp*` | Exclude files and directories starting with `temp` from any subdirectory that is two levels below the root. For example, `/somedir/subdir/temporary.txt` is excluded. |
509510
| `temp?` | Exclude files and directories in the root directory whose names are a one-character extension of `temp`. For example, `/tempa` and `/tempb` are excluded. |
510511

512+
<!-- vale on -->
513+
511514
Matching is done using Go's
512515
[`filepath.Match` function](https://golang.org/pkg/path/filepath#Match) rules.
513516
A preprocessing step uses Go's

0 commit comments

Comments
 (0)