Merge pull request #5404 from tonistiigi/docs-check-errors

docs: add note about check with errors
moby · Oct 8, 2024 · 01c1436 · 01c1436
2 parents 8c313f9 + 885b1a5
commit 01c1436
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/frontend/dockerfile/docs/reference.md b/frontend/dockerfile/docs/reference.md
@@ -345,6 +345,11 @@ despite warnings. To make the build fail on warnings, set `#check=error=true`.
 # check=error=true
 ```
 
+> [!NOTE]
+> When using the `check` directive, with `error=true` option, it is recommended
+> to pin the [Dockerfile syntax]((#syntax)) to a specific version. Otherwise, your build may
+> start to fail when new checks are added in the future versions.
+
 To combine both the `skip` and `error` options, use a semi-colon to separate
 them: