Add note in generated docs indicating experimental rule checks

Signed-off-by: Talon Bowler <[email protected]>
moby · Aug 8, 2024 · c00dd4a · c00dd4a
1 parent 8a7ba6e
commit c00dd4a
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 5 deletions.
diff --git a/frontend/dockerfile/docs/rules/copy-ignored-file.md b/frontend/dockerfile/docs/rules/copy-ignored-file.md
@@ -4,6 +4,10 @@ description: Attempting to Copy file that is excluded by .dockerignore
 aliases:
   - /go/dockerfile/rule/copy-ignored-file/
 ---
+> **Note**
+>
+> This check is experimental.
+>
 
 ## Output
 

diff --git a/frontend/dockerfile/linter/generate.go b/frontend/dockerfile/linter/generate.go
@@ -20,11 +20,12 @@ import (
 )
 
 type Rule struct {
-	Name        string
-	Description string
-	URL         *url.URL
-	PageName    string
-	URLAlias    string
+	Name         string
+	Description  string
+	URL          *url.URL
+	PageName     string
+	URLAlias     string
+	Experimental bool
 }
 
 const tmplStr = `---
@@ -35,6 +36,11 @@ aliases:
   - {{ .Rule.URLAlias }}
 {{- end }}
 ---
+{{- if .Rule.Experimental }}
+> **Note**
+>
+> This check is experimental.
+{{- end }}
 
 {{ .Content }}
 `
@@ -160,6 +166,10 @@ func listRules() ([]Rule, error) {
 										}
 										rule.URL = u
 									}
+								case "Experimental":
+									if basicLit, ok := kv.Value.(*ast.Ident); ok {
+										rule.Experimental = basicLit.Name == "true"
+									}
 								}
 							}
 						}