add fragment

Author: colleenmcginnis

changelog/fragments/1755717164-markdown.yaml

@@ -0,0 +1,55 @@
+# REQUIRED
+# Kind can be one of:
+# - breaking-change: a change to previously-documented behavior
+# - deprecation: functionality that is being removed in a later release
+# - bug-fix: fixes a problem in a previous version
+# - enhancement: extends functionality but does not break or fix existing behavior
+# - feature: new functionality
+# - known-issue: problems that we are aware of in a given version
+# - security: impacts on the security of a product or a user’s deployment.
+# - upgrade: important information for someone upgrading from a prior version
+# - other: does not fit into any of the other categories
+kind: feature
+
+# REQUIRED for all kinds
+# Change summary; a 80ish characters long description of the change.
+summary: Support outputting Markdown files.
+
+# REQUIRED for breaking-change, deprecation, known-issue
+# Long description; in case the summary is not enough to describe the change
+# this field accommodate a description without length limits.
+description: |
+  Updates the `render` command to accept `--file_type` set to either `asciidoc` or `markdown`.
+
+  When set to `asciidoc`, it renders a single AsciiDoc file for a given version using the existing `asciidoc-embedded` template.
+
+  When set to `markdown`, it renders three Markdown files for a given version:
+
+  * Release notes: Creates an `index.md` file using `markdown-index-template`.
+  * Breaking changes: Creates a `breaking.md` file using `markdown-breaking-template`.
+  * Deprecations: Creates a `deprecations.md` file using `markdown-deprecations-template`.
+
+# REQUIRED for breaking-change, deprecation, known-issue
+# impact:
+
+# REQUIRED for breaking-change, deprecation, known-issue
+# action:
+
+# REQUIRED for all kinds
+# Affected component; usually one of "elastic-agent", "fleet-server", "filebeat", "metricbeat", "auditbeat", "all", etc.
+component:
+
+# AUTOMATED
+# OPTIONAL to manually add other PR URLs
+# PR URL: A link the PR that added the changeset.
+# If not present is automatically filled by the tooling finding the PR where this changelog fragment has been added.
+# NOTE: the tooling supports backports, so it's able to fill the original PR number instead of the backport PR number.
+# Please provide it if you are adding a fragment for a different PR.
+pr:
+  - https://github.com/elastic/elastic-agent-changelog-tool/pull/213
+
+# AUTOMATED
+# OPTIONAL to manually add other issue URLs
+# Issue URL; optional; the GitHub issue related to this changeset (either closes or is part of).
+# If not present is automatically filled by the tooling with the issue linked to the PR number.
+# issue: https://github.com/owner/repo/1234

cmd/render.go

@@ -17,7 +17,8 @@ import (
 var RenderLongDescription = `Use this command to render the consolidated changelog.
 
 --version is required. Consolidated changelog version (x.y.z) in 'changelogs' folder
---file_type is required. Specify the file_type: 'asciidoc' or 'markdown'`
+--file_type is optional. Specify the file_type: 'asciidoc' or 'markdown'
+--template is optional. Specify full path to your template file or use predefined templates. Default: asciidoc-embedded`
 
 func RenderCmd(fs afero.Fs) *cobra.Command {
 	renderCmd := &cobra.Command{
@@ -42,6 +43,11 @@ func RenderCmd(fs afero.Fs) *cobra.Command {
 				return fmt.Errorf("error parsing flag 'file_type': %w", err)
 			}
 
+			template, err := cmd.Flags().GetString("template")
+			if err != nil {
+				return fmt.Errorf("error parsing flag 'template': %w", err)
+			}
+
 			c, err := changelog.FromFile(fs, fmt.Sprintf("./%s/%s.yaml", dest, version))
 			if err != nil {
 				return fmt.Errorf("error loading changelog from file: %w", err)
@@ -55,23 +61,29 @@ func RenderCmd(fs afero.Fs) *cobra.Command {
 			} else if file_type == "markdown" {
 				r_index := changelog.NewRenderer(fs, c, renderedDest, "markdown-index", repo)
 				if err := r_index.Render(); err != nil {
-					return fmt.Errorf("cannot build asciidoc file: %w", err)
+					return fmt.Errorf("cannot build markdown file: %w", err)
 				}
 				r_breaking := changelog.NewRenderer(fs, c, renderedDest, "markdown-breaking", repo)
 				if err := r_breaking.Render(); err != nil {
-					return fmt.Errorf("cannot build asciidoc file: %w", err)
+					return fmt.Errorf("cannot build markdown file: %w", err)
 				}
 				r_deprecations := changelog.NewRenderer(fs, c, renderedDest, "markdown-deprecations", repo)
 				if err := r_deprecations.Render(); err != nil {
-					return fmt.Errorf("cannot build asciidoc file: %w", err)
+					return fmt.Errorf("cannot build markdown file: %w", err)
+				}
+			} else {
+				r := changelog.NewRenderer(fs, c, renderedDest, template, repo)
+				if err := r.Render(); err != nil {
+					return fmt.Errorf("cannot build file: %w", err)
 				}
 			}
 
 			return nil
 		},
 	}
 
-	renderCmd.Flags().String("file_type", viper.GetString("file_type"), "The file type used to generate the changelog: `asciidoc` or `markdown`")
+	renderCmd.Flags().String("file_type", viper.GetString("file_type"), "The file type of the rendered release notes: `asciidoc` or `markdown`")
+	renderCmd.Flags().String("template", viper.GetString("template"), "The template used to generate the changelog")
 	renderCmd.Flags().String("version", "", "The version of the consolidated changelog being created")
 	err := renderCmd.MarkFlagRequired("version")
 	if err != nil {

config.changelog.yaml

@@ -0,0 +1,3 @@
+owner: elastic
+repo: elastic-agent-changelog-tool
+rendered_changelog_destination: changelog