Merge pull request #5475 from dvdksn/fix-docs-yaml-soup

Dockerfile: escape formatting issues in rule descriptions
moby · Oct 31, 2024 · 354f2d1 · 354f2d1
2 parents 4622a2b + 819d7bc
commit 354f2d1
Show file tree

Hide file tree

Showing 21 changed files with 41 additions and 21 deletions.
diff --git a/frontend/dockerfile/docs/reference.md b/frontend/dockerfile/docs/reference.md
@@ -347,7 +347,7 @@ despite warnings. To make the build fail on warnings, set `#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
+> 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

diff --git a/frontend/dockerfile/docs/rules/consistent-instruction-casing.md b/frontend/dockerfile/docs/rules/consistent-instruction-casing.md
@@ -1,6 +1,7 @@
 ---
 title: ConsistentInstructionCasing
-description: All commands within the Dockerfile should use the same casing (either upper or lower)
+description: >-
+  All commands within the Dockerfile should use the same casing (either upper or lower)
 aliases:
   - /go/dockerfile/rule/consistent-instruction-casing/
 ---

diff --git a/frontend/dockerfile/docs/rules/copy-ignored-file.md b/frontend/dockerfile/docs/rules/copy-ignored-file.md
@@ -1,6 +1,7 @@
 ---
 title: CopyIgnoredFile
-description: Attempting to Copy file that is excluded by .dockerignore
+description: >-
+  Attempting to Copy file that is excluded by .dockerignore
 aliases:
   - /go/dockerfile/rule/copy-ignored-file/
 ---

diff --git a/frontend/dockerfile/docs/rules/duplicate-stage-name.md b/frontend/dockerfile/docs/rules/duplicate-stage-name.md
@@ -1,6 +1,7 @@
 ---
 title: DuplicateStageName
-description: Stage names should be unique
+description: >-
+  Stage names should be unique
 aliases:
   - /go/dockerfile/rule/duplicate-stage-name/
 ---

diff --git a/frontend/dockerfile/docs/rules/from-as-casing.md b/frontend/dockerfile/docs/rules/from-as-casing.md
@@ -1,6 +1,7 @@
 ---
 title: FromAsCasing
-description: The 'as' keyword should match the case of the 'from' keyword
+description: >-
+  The 'as' keyword should match the case of the 'from' keyword
 aliases:
   - /go/dockerfile/rule/from-as-casing/
 ---

diff --git a/frontend/dockerfile/docs/rules/from-platform-flag-const-disallowed.md b/frontend/dockerfile/docs/rules/from-platform-flag-const-disallowed.md
@@ -1,6 +1,7 @@
 ---
 title: FromPlatformFlagConstDisallowed
-description: FROM --platform flag should not use a constant value
+description: >-
+  FROM --platform flag should not use a constant value
 aliases:
   - /go/dockerfile/rule/from-platform-flag-const-disallowed/
 ---

diff --git a/frontend/dockerfile/docs/rules/invalid-default-arg-in-from.md b/frontend/dockerfile/docs/rules/invalid-default-arg-in-from.md
@@ -1,6 +1,7 @@
 ---
 title: InvalidDefaultArgInFrom
-description: Default value for global ARG results in an empty or invalid base image name
+description: >-
+  Default value for global ARG results in an empty or invalid base image name
 aliases:
   - /go/dockerfile/rule/invalid-default-arg-in-from/
 ---

diff --git a/frontend/dockerfile/docs/rules/invalid-definition-description.md b/frontend/dockerfile/docs/rules/invalid-definition-description.md
@@ -1,6 +1,7 @@
 ---
 title: InvalidDefinitionDescription
-description: Comment for build stage or argument should follow the format: `# <arg/stage name> <description>`. If this is not intended to be a description comment, add an empty line or comment between the instruction and the comment.
+description: >-
+  Comment for build stage or argument should follow the format: `# <arg/stage name> <description>`. If this is not intended to be a description comment, add an empty line or comment between the instruction and the comment.
 aliases:
   - /go/dockerfile/rule/invalid-definition-description/
 ---

diff --git a/frontend/dockerfile/docs/rules/json-args-recommended.md b/frontend/dockerfile/docs/rules/json-args-recommended.md
@@ -1,6 +1,7 @@
 ---
 title: JSONArgsRecommended
-description: JSON arguments recommended for ENTRYPOINT/CMD to prevent unintended behavior related to OS signals
+description: >-
+  JSON arguments recommended for ENTRYPOINT/CMD to prevent unintended behavior related to OS signals
 aliases:
   - /go/dockerfile/rule/json-args-recommended/
 ---

diff --git a/frontend/dockerfile/docs/rules/legacy-key-value-format.md b/frontend/dockerfile/docs/rules/legacy-key-value-format.md
@@ -1,6 +1,7 @@
 ---
 title: LegacyKeyValueFormat
-description: Legacy key/value format with whitespace separator should not be used
+description: >-
+  Legacy key/value format with whitespace separator should not be used
 aliases:
   - /go/dockerfile/rule/legacy-key-value-format/
 ---

diff --git a/frontend/dockerfile/docs/rules/maintainer-deprecated.md b/frontend/dockerfile/docs/rules/maintainer-deprecated.md
@@ -1,6 +1,7 @@
 ---
 title: MaintainerDeprecated
-description: The MAINTAINER instruction is deprecated, use a label instead to define an image author
+description: >-
+  The MAINTAINER instruction is deprecated, use a label instead to define an image author
 aliases:
   - /go/dockerfile/rule/maintainer-deprecated/
 ---

diff --git a/frontend/dockerfile/docs/rules/multiple-instructions-disallowed.md b/frontend/dockerfile/docs/rules/multiple-instructions-disallowed.md
@@ -1,6 +1,7 @@
 ---
 title: MultipleInstructionsDisallowed
-description: Multiple instructions of the same type should not be used in the same stage
+description: >-
+  Multiple instructions of the same type should not be used in the same stage
 aliases:
   - /go/dockerfile/rule/multiple-instructions-disallowed/
 ---

diff --git a/frontend/dockerfile/docs/rules/no-empty-continuation.md b/frontend/dockerfile/docs/rules/no-empty-continuation.md
@@ -1,6 +1,7 @@
 ---
 title: NoEmptyContinuation
-description: Empty continuation lines will become errors in a future release
+description: >-
+  Empty continuation lines will become errors in a future release
 aliases:
   - /go/dockerfile/rule/no-empty-continuation/
 ---

diff --git a/frontend/dockerfile/docs/rules/redundant-target-platform.md b/frontend/dockerfile/docs/rules/redundant-target-platform.md
@@ -1,6 +1,7 @@
 ---
 title: RedundantTargetPlatform
-description: Setting platform to predefined $TARGETPLATFORM in FROM is redundant as this is the default behavior
+description: >-
+  Setting platform to predefined $TARGETPLATFORM in FROM is redundant as this is the default behavior
 aliases:
   - /go/dockerfile/rule/redundant-target-platform/
 ---

diff --git a/frontend/dockerfile/docs/rules/reserved-stage-name.md b/frontend/dockerfile/docs/rules/reserved-stage-name.md
@@ -1,6 +1,7 @@
 ---
 title: ReservedStageName
-description: Reserved words should not be used as stage names
+description: >-
+  Reserved words should not be used as stage names
 aliases:
   - /go/dockerfile/rule/reserved-stage-name/
 ---

diff --git a/frontend/dockerfile/docs/rules/secrets-used-in-arg-or-env.md b/frontend/dockerfile/docs/rules/secrets-used-in-arg-or-env.md
@@ -1,6 +1,7 @@
 ---
 title: SecretsUsedInArgOrEnv
-description: Sensitive data should not be used in the ARG or ENV commands
+description: >-
+  Sensitive data should not be used in the ARG or ENV commands
 aliases:
   - /go/dockerfile/rule/secrets-used-in-arg-or-env/
 ---

diff --git a/frontend/dockerfile/docs/rules/stage-name-casing.md b/frontend/dockerfile/docs/rules/stage-name-casing.md
@@ -1,6 +1,7 @@
 ---
 title: StageNameCasing
-description: Stage names should be lowercase
+description: >-
+  Stage names should be lowercase
 aliases:
   - /go/dockerfile/rule/stage-name-casing/
 ---

diff --git a/frontend/dockerfile/docs/rules/undefined-arg-in-from.md b/frontend/dockerfile/docs/rules/undefined-arg-in-from.md
@@ -1,6 +1,7 @@
 ---
 title: UndefinedArgInFrom
-description: FROM command must use declared ARGs
+description: >-
+  FROM command must use declared ARGs
 aliases:
   - /go/dockerfile/rule/undefined-arg-in-from/
 ---

diff --git a/frontend/dockerfile/docs/rules/undefined-var.md b/frontend/dockerfile/docs/rules/undefined-var.md
@@ -1,6 +1,7 @@
 ---
 title: UndefinedVar
-description: Variables should be defined before their use
+description: >-
+  Variables should be defined before their use
 aliases:
   - /go/dockerfile/rule/undefined-var/
 ---

diff --git a/frontend/dockerfile/docs/rules/workdir-relative-path.md b/frontend/dockerfile/docs/rules/workdir-relative-path.md
@@ -1,6 +1,7 @@
 ---
 title: WorkdirRelativePath
-description: Relative workdir without an absolute workdir declared within the build can have unexpected results if the base image changes
+description: >-
+  Relative workdir without an absolute workdir declared within the build can have unexpected results if the base image changes
 aliases:
   - /go/dockerfile/rule/workdir-relative-path/
 ---

diff --git a/frontend/dockerfile/linter/generate.go b/frontend/dockerfile/linter/generate.go
@@ -30,7 +30,8 @@ type Rule struct {
 
 const tmplStr = `---
 title: {{ .Rule.Name }}
-description: {{ .Rule.Description }}
+description: >-
+  {{ .Rule.Description }}
 {{- if .Rule.URLAlias }}
 aliases:
   - {{ .Rule.URLAlias }}