Add autogen warning to index file

pulumi · Oct 17, 2024 · 1ffc289 · 1ffc289
1 parent 52f4f79
commit 1ffc289
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/pkg/tfgen/installation_docs.go b/pkg/tfgen/installation_docs.go
@@ -53,8 +53,12 @@ func plainDocsParser(docFile *DocFile, g *Generator) ([]byte, error) {
 	// Determine if we should write an overview header.
 	overviewHeader := getOverviewHeader(content)
 
+	autoGenMessage := fmt.Sprint(
+		"<!-- *** WARNING: This file was auto-generated. " +
+			"Do not edit by hand unless you're certain you know what you are doing! *** -->\n")
+
 	// Add instructions to top of file
-	contentStr := frontMatter + installationInstructions + overviewHeader + string(content)
+	contentStr := frontMatter + autoGenMessage + installationInstructions + overviewHeader + string(content)
 
 	//Translate code blocks to Pulumi
 	contentStr, err = translateCodeBlocks(contentStr, g)