refactor: Rename Header to Heading in MarkdownOptions

Author: TsekNet

cmd/fleet-plan/cmd_test.go

@@ -117,7 +117,7 @@ func TestRootFlagsIncludeAllFlags(t *testing.T) {
 	}
 
 	output := buf.String()
-	for _, flag := range []string{"--team", "--default", "--verbose", "--ci-header", "--ci-marker", "--detailed-exitcode"} {
+	for _, flag := range []string{"--team", "--default", "--verbose", "--ci-heading", "--ci-marker", "--detailed-exitcode"} {
 		if !strings.Contains(output, flag) {
 			t.Errorf("help should mention %s, got:\n%s", flag, output)
 		}

cmd/fleet-plan/main.go

@@ -36,7 +36,7 @@ var (
 	flagVerbose          bool
 	flagTeams            []string
 	flagDefault          string
-	flagCIHeader         string
+	flagCIHeading        string
 	flagCIMarker         string
 	flagDetailedExitCode bool
 	flagChangedFiles     []string
@@ -64,7 +64,7 @@ Strictly read-only -- GET requests only.`,
 	pf.BoolVarP(&flagVerbose, "verbose", "v", false, "show full old/new values for modified fields")
 	pf.StringSliceVar(&flagTeams, "team", nil, "diff only these teams (repeatable, default: all)")
 	pf.StringVar(&flagDefault, "default", "", "path to default.yml (overrides auto-detection)")
-	pf.StringVar(&flagCIHeader, "ci-header", "", "blockquote header prepended to markdown output (CI use)")
+	pf.StringVar(&flagCIHeading, "ci-heading", "", "## heading for markdown output (CI use)")
 	pf.StringVar(&flagCIMarker, "ci-marker", "", "HTML comment marker appended to markdown output for idempotent MR note updates")
 	pf.BoolVar(&flagDetailedExitCode, "detailed-exitcode", false, "exit 2 when changes detected (0=no changes, 1=error, 2=changes)")
 	pf.StringSliceVar(&flagChangedFiles, "changed-file", nil, "only show diffs for resources from these source files (repeatable, CI use)")
@@ -131,8 +131,8 @@ func runDiff(cmd *cobra.Command, _ []string) error {
 		fmt.Println(out)
 	case "markdown":
 		opts := output.MarkdownOptions{
-			Header: flagCIHeader,
-			Marker: flagCIMarker,
+			Heading: flagCIHeading,
+			Marker:  flagCIMarker,
 		}
 		fmt.Println(output.RenderDiffMarkdown(results, opts))
 	default:

internal/output/markdown.go

@@ -10,7 +10,7 @@ import (
 
 // MarkdownOptions controls optional CI-oriented additions to markdown output.
 type MarkdownOptions struct {
-	Header string // blockquote line prepended after the heading (e.g. "> Comparing against **prod**")
+	Heading string // ## heading text (e.g. "Planned changes for fleet.example.com")
 	Marker string // HTML comment appended for idempotent MR note updates
 }
 
@@ -53,11 +53,11 @@ var permissionErrors = map[string]string{
 func RenderDiffMarkdown(results []diff.DiffResult, opts MarkdownOptions) string {
 	var sb strings.Builder
 
-	sb.WriteString("## fleet-plan\n\n")
-
-	if opts.Header != "" {
-		sb.WriteString(opts.Header + "\n\n")
+	heading := "fleet-plan"
+	if opts.Heading != "" {
+		heading = opts.Heading
 	}
+	sb.WriteString("## " + heading + "\n\n")
 
 	if !HasChanges(results) {
 		sb.WriteString("No changes detected. Your branch matches the current Fleet state.\n")

internal/output/markdown_test.go

@@ -234,13 +234,13 @@ func TestRenderDiffMarkdown(t *testing.T) {
 			},
 		},
 		{
-			name:    "ci-header prepended",
+			name:    "ci-heading as heading",
 			results: []diff.DiffResult{{
 				Team:     "T",
 				Policies: diff.ResourceDiff{Added: []diff.ResourceChange{{Name: "P"}}},
 			}},
-			opts:    MarkdownOptions{Header: "> Comparing against **production**"},
-			wantAll: []string{"## fleet-plan", "> Comparing against **production**", "**1 added**"},
+			opts:    MarkdownOptions{Heading: "Planned changes for fleet.example.com"},
+			wantAll: []string{"## Planned changes for fleet.example.com", "**1 added**"},
 		},
 		{
 			name:    "ci-marker appended",
@@ -258,10 +258,10 @@ func TestRenderDiffMarkdown(t *testing.T) {
 			wantAll: []string{"No changes detected", "<!-- fleet-plan-marker -->"},
 		},
 		{
-			name:    "ci-header on no changes",
+			name:    "ci-heading on no changes",
 			results: nil,
-			opts:    MarkdownOptions{Header: "> env info"},
-			wantAll: []string{"> env info", "No changes detected"},
+			opts:    MarkdownOptions{Heading: "Planned changes for fleet.example.com"},
+			wantAll: []string{"## Planned changes for fleet.example.com", "No changes detected"},
 		},
 		{
 			name: "host count formatting with commas",