package all markdown templates in one command

Author: colleenmcginnis

cmd/render.go

@@ -52,10 +52,24 @@ func RenderCmd(fs afero.Fs) *cobra.Command {
 				return fmt.Errorf("error loading changelog from file: %w", err)
 			}
 
-			r := changelog.NewRenderer(fs, c, renderedDest, template, repo)
-
-			if err := r.Render(); err != nil {
-				return fmt.Errorf("cannot build asciidoc file: %w", err)
+			if template == "asciidoc-embedded" {
+				r := changelog.NewRenderer(fs, c, renderedDest, template, repo)
+				if err := r.Render(); err != nil {
+					return fmt.Errorf("cannot build asciidoc file: %w", err)
+				}
+			} else if template == "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)
+				}
+				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)
+				}
+				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 nil

docs/configuration.md

@@ -1,21 +1,29 @@
 # Configuration options
 
-`elastic-agent-changelog-tool` has configuration options available to change it's behaviour.
+`elastic-agent-changelog-tool` has configuration options available to change its behaviour.
 
-All settings are managed via the [`settings`][settings] package, using [`spf13/viper`][viper].  
+All settings are managed via the [`settings`][settings] package, using [`spf13/viper`][viper].
 Configurations are bound to environment variables with same name and `ELASTIC_AGENT_CHANGELOG` prefix using [`viper.BindEnv`][bindenv].
 
 This CLI supports and adhere to cross platform XDG Standard provided by [`OpenPeeDeeP/xdg`][xdg].
 
-|Settings key|Default value|Note|
+| Settings | Default value | Description |
 |---|---|---|
-|`fragment_location`|`$GIT_REPO_ROOT/changelog/fragments`|The location of changelog fragments used by the CLI. By default `fragment_root` + `fragment_path`.| 
+|`fragment_location`|`$GIT_REPO_ROOT/changelog/fragments`|The location of changelog fragments used by the CLI. By default `fragment_root` + `fragment_path`.|
 |`fragment_path`|`changelog/fragments`|The path in `fragment_root` where to locate changelog fragments.|
 |`fragment_root`|`$GIT_REPO_ROOT`|The root folder for `fragment_location`.|
 
 ## Configuration file
 
-Not supported yet.
+Add a `config.changelog.yaml` file to the repo where you're generating release notes.
+
+When generating Markdown files, at a minimum you should set the following settings:
+
+| Setting | Default value | Description |
+|---|---|---|
+| `owner` (required) | `elastic` | The owner of the GitHub repo. |
+| `repo` (required) | ‒ | The name of the GitHub repo. |
+| `rendered_changelog_destination` | `changelog` | The directory where you want to put the generated files.<br><br>When generating Markdown files, this should probably be `docs/release-notes/_snippets`. |
 
 ## Supported Environment Variables
 

docs/getting-started.md

@@ -25,6 +25,7 @@ $ elastic-agent-changelog-tool new "my test fragment"
 This will create `./changelog/fragments/<timestamp>-my-test-fragment.yaml` with this content:
 
 ```yaml
+# REQUIRED
 # Kind can be one of:
 # - breaking-change: a change to previously-documented behavior
 # - deprecation: functionality that is being removed in a later release
@@ -37,25 +38,39 @@ This will create `./changelog/fragments/<timestamp>-my-test-fragment.yaml` with
 # - 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:
+summary: {{.Summary}}
 
+# 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:
+# description:
 
+# 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:
 
-# PR URL; optional; the PR number that added the changeset.
+# 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/owner/repo/1234
+# pr: https://github.com/owner/repo/1234
 
+# 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
+# issue: https://github.com/owner/repo/1234
+
 ```
 
 Ensure `kind` is correct and fill the `summary` field with a brief description.
@@ -80,7 +95,7 @@ entries:
       kind: feature
       pr:
           - https://github.com/elastic/elastic-agent-changelog-tool/pull/13
-      issue: 
+      issue:
           - https://github.com/elastic/elastic-agent-changelog-tool/issues/21
       timestamp: 1649924282
       file:
@@ -93,12 +108,26 @@ There will be multiple entries, one for each files in `changelog/fragments`.
 
 ## 5. Render the consolidated changelog
 
-_Note_: at the moment there is only one renderer implemented: Asciidoc.
+### Markdown
+
+From the root folder of the repository run:
+
+```
+$ elastic-agent-changelog-tool render --version 0.1.0 --template markdown
+```
+
+This will create three files:
+
+* `./changelog/0.1.0/index.md`
+* `./changelog/0.1.0/breaking.md`
+* `./changelog/0.1.0/deprecations.md`
+
+### AsciiDoc
 
 From the root folder of the repository run:
 
 ```
-$ elastic-agent-changelog-tool render --version 0.1.0
+$ elastic-agent-changelog-tool render --version 0.1.0 --template asciidoc-embedded
 ```
 
 This will create `./changelog/0.1.0.asciidoc`.

internal/changelog/renderer.go

@@ -39,7 +39,7 @@ func NewRenderer(fs afero.Fs, c Changelog, dest string, templ string, repo strin
 }
 
 func (r Renderer) Render() error {
-	log.Printf("render changelog for version: %s\n", r.changelog.Version)
+	log.Printf("render %s for version: %s\n", r.templ, r.changelog.Version)
 
 	tpl, err := r.Template()
 	if err != nil {
@@ -133,11 +133,7 @@ func (r Renderer) Render() error {
 				if len(td.KnownIssue) > 0 {
 					links = append(
 						links,
-						fmt.Sprintf(
-							"[Known issues](/release-notes/known-issues.md#%s-%s-known-issues)",
-							r.repo,
-							r.changelog.Version,
-						),
+						"[Known issues](/release-notes/known-issues.md)",
 					)
 				}
 				if len(td.BreakingChange) > 0 {

internal/settings/settings.go

@@ -59,7 +59,7 @@ func setDefaults() {
 		viper.GetString("fragment_path")))
 
 	viper.SetDefault("changelog_destination", "changelog")
-	// viper.SetDefault("rendered_changelog_destination", "changelog")
+	viper.SetDefault("rendered_changelog_destination", "changelog")
 
 	viper.SetDefault("template", "asciidoc-embedded")
 }