rename template to file_type

Author: colleenmcginnis

cmd/render.go

@@ -8,21 +8,16 @@ import (
 	"fmt"
 	"log"
 
-	"github.com/elastic/elastic-agent-changelog-tool/internal/assets"
 	"github.com/elastic/elastic-agent-changelog-tool/internal/changelog"
 	"github.com/spf13/afero"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
 
-var RenderLongDescription = fmt.Sprintf(`Use this command to render the consolidated changelog.
+var RenderLongDescription = `Use this command to render the consolidated changelog.
 
 --version is required. Consolidated changelog version (x.y.z) in 'changelogs' folder
---template is optional. Specify full path to your template file or use predefined templates. Default: asciidoc-embedded
-
-Predefined templates:
-%s
-`, assets.GetEmbeddedTemplates().String())
+--file_type is required. Specify the file_type: 'asciidoc' or 'markdown'`
 
 func RenderCmd(fs afero.Fs) *cobra.Command {
 	renderCmd := &cobra.Command{
@@ -42,22 +37,22 @@ func RenderCmd(fs afero.Fs) *cobra.Command {
 				return fmt.Errorf("error parsing flag 'version': %w", err)
 			}
 
-			template, err := cmd.Flags().GetString("template")
+			file_type, err := cmd.Flags().GetString("file_type")
 			if err != nil {
-				return fmt.Errorf("error parsing flag 'template': %w", err)
+				return fmt.Errorf("error parsing flag 'file_type': %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)
 			}
 
-			if template == "asciidoc-embedded" {
-				r := changelog.NewRenderer(fs, c, renderedDest, template, repo)
+			if file_type == "asciidoc" {
+				r := changelog.NewRenderer(fs, c, renderedDest, "asciidoc-embedded", repo)
 				if err := r.Render(); err != nil {
 					return fmt.Errorf("cannot build asciidoc file: %w", err)
 				}
-			} else if template == "markdown" {
+			} 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)
@@ -76,7 +71,7 @@ func RenderCmd(fs afero.Fs) *cobra.Command {
 		},
 	}
 
-	renderCmd.Flags().String("template", viper.GetString("template"), "The template used to generate the changelog")
+	renderCmd.Flags().String("file_type", viper.GetString("file_type"), "The file type used to generate the changelog: `asciidoc` or `markdown`")
 	renderCmd.Flags().String("version", "", "The version of the consolidated changelog being created")
 	err := renderCmd.MarkFlagRequired("version")
 	if err != nil {

docs/getting-started.md

@@ -113,7 +113,7 @@ There will be multiple entries, one for each files in `changelog/fragments`.
 From the root folder of the repository run:
 
 ```
-$ elastic-agent-changelog-tool render --version 0.1.0 --template markdown
+$ elastic-agent-changelog-tool render --version 0.1.0 --file_type markdown
 ```
 
 This will create three files:
@@ -127,7 +127,7 @@ This will create three files:
 From the root folder of the repository run:
 
 ```
-$ elastic-agent-changelog-tool render --version 0.1.0 --template asciidoc-embedded
+$ elastic-agent-changelog-tool render --version 0.1.0 --file_type asciidoc
 ```
 
 This will create `./changelog/0.1.0.asciidoc`.

docs/usage.md

@@ -43,11 +43,9 @@ $ elastic-agent-changelog-tool build --version=next --owner <owner> --repo <repo
 
 then render the consolidated changelog with:
 ```
-$ elastic-agent-changelog-tool render --version=next --template <template>
+$ elastic-agent-changelog-tool render --version=next --file_type <asciidoc|markdown>
 ```
 
-The template value can be chosen from a predefined internal list of templates (`render --help`) or use a full path to your template file.
-
 An example is [`../changelog/0.1.0.yaml`](../changelog/0.1.0.yaml).
 
 ### My PR does not need a changelog
@@ -82,9 +80,8 @@ $ elastic-agent-changelog-tool build --version=next --owner <owner> --repo <repo
 
 then render the consolidated changelog with:
 ```
-$ $ elastic-agent-changelog-tool render --version=next --template <template>
+$ elastic-agent-changelog-tool render --version=next --file_type <asciidoc|markdown>
 ```
-The template value can be chosen from a predefined internal list of templates (`render --help`) or use a full path to your template file.
 
 An example is [`../changelog/0.1.0.yaml`](../changelog/0.1.0.yaml).
 
@@ -97,8 +94,14 @@ The side effect is that the changelog will include all entries from latest stabl
 
 1. Create consolidated changelog with `$ elastic-agent-changelog-tool build --version <version> --owner <owner> --repo <repo>`;
 * This will create `./changelog/x.y.z.yaml`;
-2. Create rendered changelog with `$ elastic-agent-changelog-tool render --version <version> --template <template>`;
-* This will generate an asciidoc file in the `changelog/` directory;
+2. Create rendered changelog with `$ elastic-agent-changelog-tool render --version <version> --file_type <asciidoc|markdown>`;
+
+    Depending on the specified `file_type`, this will generate the following files:
+    * `markdown`:
+      * Release notes: `./changelog/<version>/index.md`
+      * Breaking changes: `./changelog/<version>/breaking.md`
+      * Deprecations: `./changelog/<version>/deprecations.md`
+    * `asciidoc`: `changelog/<version>.asciidoc`
 3. Use the rendered changelog.
 
 **Note**: we do not remove fragments, as they will be needed for the stable release version changelog.
@@ -111,30 +114,39 @@ The side effect is that the changelog will include all entries from latest stabl
 
 These steps require [GitHub Authentication](./github-authentication.md).
 
-* Wait for the last BC of the release. If another BC is generated after that or a patch version for a previous minor is released, you might need to restart the process.
-* Create a branch **from the commit of the BC**.
-* From the root folder of the repository run:
-
-```
-$ elastic-agent-changelog-tool build --version x.y.z --owner <owner> --repo <repo>
-```
-* Where:
-  * `x.y.z` is the version to release.
-  * `owner` is the user / organization the repository to use belongs to. The default value is `elastic`.
-  * `repo` is the name of the repository containing the issues / PRs, etc. The default value is `elastic-agent`.
-* This will create `./changelog/x.y.z.yaml`.
-* From the root of the repository run:
-```
-$ elastic-agent-changelog-tool cleanup
-```
-* Commit the previous changes (consolidated changelod and removed files)
-* From the root folder of the repository run:
-```
-$ elastic-agent-changelog-tool render --version x.y.z --template <template>
-```
-* This will generate an asciidoc fragment in the `changelog/` directory.
-* Integrate the generated fragment into the changelog. If the changelog is stored in the same repository, commit the changes in this same branch.
-* Create a PR with the changes to the `x.y` branch.
+1. Wait for the last BC of the release. If another BC is generated after that or a patch version for a previous minor is released, you might need to restart the process.
+1. Create a branch **from the commit of the BC**.
+1. From the root folder of the repository run:
+
+    ```
+    $ elastic-agent-changelog-tool build --version x.y.z --owner <owner> --repo <repo>
+    ```
+
+    Where:
+
+    * `x.y.z` is the version to release.
+    * `owner` is the user / organization the repository to use belongs to. The default value is `elastic`.
+    * `repo` is the name of the repository containing the issues / PRs, etc. The default value is `elastic-agent`.
+
+    This will create `./changelog/x.y.z.yaml`.
+1. From the root of the repository run:
+    ```
+    $ elastic-agent-changelog-tool cleanup
+    ```
+1. Commit the previous changes (consolidated changelod and removed files)
+1. From the root folder of the repository run:
+    ```
+    $ elastic-agent-changelog-tool render --version x.y.z --file_type <asciidoc|markdown>
+    ```
+
+    Depending on the specified `file_type`, this will generate the following files:
+    * `markdown`:
+      * Release notes: `./changelog/<version>/index.md`
+      * Breaking changes: `./changelog/<version>/breaking.md`
+      * Deprecations: `./changelog/<version>/deprecations.md`
+    * `asciidoc`: `changelog/<version>.asciidoc`
+1. Integrate the generated fragment into the changelog. If the changelog is stored in the same repository, commit the changes in this same branch.
+1. Create a PR with the changes to the `x.y` branch.
 
 
 ### On Release Day