diff --git a/frontend/dockerfile/docs/rules/_index.md b/frontend/dockerfile/docs/rules/_index.md index 932ce1813a6a3..0938ace3dfe87 100644 --- a/frontend/dockerfile/docs/rules/_index.md +++ b/frontend/dockerfile/docs/rules/_index.md @@ -104,7 +104,7 @@ To learn more about how to use build checks, see Attempting to Copy file that is excluded by .dockerignore - InvalidDefinitionDescription + InvalidDefinitionDescription (experimental) Comment for build stage or argument should follow the format: `# `. If this is not intended to be a description comment, add an empty line or comment between the instruction and the comment. diff --git a/frontend/dockerfile/docs/rules/invalid-definition-description.md b/frontend/dockerfile/docs/rules/invalid-definition-description.md index 3e9044c417f0b..23d353c03c6f0 100644 --- a/frontend/dockerfile/docs/rules/invalid-definition-description.md +++ b/frontend/dockerfile/docs/rules/invalid-definition-description.md @@ -5,6 +5,10 @@ aliases: - /go/dockerfile/rule/invalid-definition-description/ --- +> [!NOTE] +> This check is experimental and is not enabled by default. To enable it, see +> [Experimental checks](https://docs.docker.com/go/build-checks-experimental/). + ## Output ```text diff --git a/frontend/dockerfile/linter/ruleset.go b/frontend/dockerfile/linter/ruleset.go index 2a776aa88eccc..63cc0013ef2b2 100644 --- a/frontend/dockerfile/linter/ruleset.go +++ b/frontend/dockerfile/linter/ruleset.go @@ -172,5 +172,6 @@ var ( Format: func(instruction, defName string) string { return fmt.Sprintf("Comment for %s should follow the format: `# %s `", instruction, defName) }, + Experimental: true, } )