Add --md-header-base-level CLI option

Author: bernd

changelog/config.go

@@ -5,12 +5,13 @@ import "regexp"
 var SemverVersionPattern = regexp.MustCompile("^\\d+\\.\\d+\\.\\d+$")
 
 type Config struct {
-	RenderFormat      string
-	RenderGitHubLinks bool
-	SnippetsPaths     []string
-	ReleaseDate       string
-	ReleaseVersion    string
-	Product           string
-	SkipHeader        bool
-	ReadStdin         bool
+	RenderFormat            string
+	RenderGitHubLinks       bool
+	SnippetsPaths           []string
+	ReleaseDate             string
+	ReleaseVersion          string
+	Product                 string
+	SkipHeader              bool
+	ReadStdin               bool
+	MarkdownHeaderBaseLevel int
 }

changelog/formatter.go

@@ -198,13 +198,13 @@ type MarkdownFormatter struct {
 }
 
 func (m MarkdownFormatter) RenderHeader(config Config, buf *bytes.Buffer) error {
-	buf.WriteString(fmt.Sprintf("# %s %s\n\n", config.Product, config.ReleaseVersion))
+	buf.WriteString(fmt.Sprintf("%s %s %s\n\n", strings.Repeat("#", config.MarkdownHeaderBaseLevel), config.Product, config.ReleaseVersion))
 	buf.WriteString(fmt.Sprintf("Released: %s\n\n", config.ReleaseDate))
 	return nil
 }
 
 func (m MarkdownFormatter) RenderType(config Config, snippetType string, buf *bytes.Buffer) error {
-	buf.WriteString("## ")
+	buf.WriteString(fmt.Sprintf("%s ", strings.Repeat("#", config.MarkdownHeaderBaseLevel+1)))
 	buf.WriteString(titleCaser.String(snippetType))
 	buf.WriteString("\n\n")
 	return nil

cmd/changelog.go

@@ -103,6 +103,7 @@ var changelogEntryMinimalTemplate bool
 var changelogEntryInteractive bool
 var changelogSkipHeader bool
 var changelogReadStdin bool
+var changelogMarkdownHeaderBaseLevel int
 
 func init() {
 	changelogCmd.AddCommand(changelogRenderCmd)
@@ -131,6 +132,7 @@ func applyChangelogRenderFlags(cmd *cobra.Command) {
 	cmd.Flags().StringVarP(&changelogProduct, "product", "p", "Graylog", "The product name. (e.g., \"Graylog\", \"Graylog Enterprise\")")
 	cmd.Flags().BoolVar(&changelogSkipHeader, "skip-header", false, "Don't render the header")
 	cmd.Flags().BoolVar(&changelogReadStdin, "stdin", false, "Read paths from STDIN")
+	cmd.Flags().IntVar(&changelogMarkdownHeaderBaseLevel, "md-header-base-level", 1, "The Markdown header base level")
 }
 
 func changelogRenderCommand(cmd *cobra.Command, args []string) {
@@ -189,14 +191,15 @@ func execChangelogRenderCommand(snippetsPaths []string) error {
 	}
 
 	config := changelog.Config{
-		RenderFormat:      changelogRenderFormat,
-		RenderGitHubLinks: !changelogDisableGitHubLinks,
-		SnippetsPaths:     snippetsPaths,
-		ReleaseDate:       changelogReleaseDate,
-		ReleaseVersion:    releaseVersion,
-		Product:           changelogProduct,
-		ReadStdin:         changelogReadStdin,
-		SkipHeader:        changelogSkipHeader,
+		RenderFormat:            changelogRenderFormat,
+		RenderGitHubLinks:       !changelogDisableGitHubLinks,
+		SnippetsPaths:           snippetsPaths,
+		ReleaseDate:             changelogReleaseDate,
+		ReleaseVersion:          releaseVersion,
+		Product:                 changelogProduct,
+		ReadStdin:               changelogReadStdin,
+		SkipHeader:              changelogSkipHeader,
+		MarkdownHeaderBaseLevel: changelogMarkdownHeaderBaseLevel,
 	}
 
 	if err := changelog.Render(config); err != nil {