changelog-entry: rename from changelog-gen, update README, add --dir flag

Author: mikemorris

cmd/changelog-entry/README.md

@@ -0,0 +1,33 @@
+# changelog-entry
+
+`changelog-entry` is a command that will generate a changelog entry based on the information passed and the information retrieved from the Github repository.
+
+The default changelog entry template is embedded from [`changelog-entry.tmpl`](changelog-entry.tmpl) but a path to a custom template can also can be passed as parameter.
+
+The type parameter can be one of the following:
+* bug
+* note
+* enhancement
+* new-resource
+* new-datasource
+* deprecation
+* breaking-change
+* feature
+
+## Usage
+
+```sh
+$ changelog-entry -type improvement -subcategory monitoring -description "optimize the monitoring endpoint to avoid losing logs when under high load"
+```
+
+If parameters are missing the command will prompt to fill them, the pull request number is optional and if not provided the command will try to guess it based on the current branch name and remote if the current directory is in a git repository.
+
+## Output
+
+``````markdown
+```release-note:improvement
+monitoring: optimize the monitoring endpoint to avoid losing logs when under high load
+```
+``````
+
+Any failures will be logged to stderr. The entry will be written to a file named `{PR_NUMBER}.txt`, in the current directory unless an output path is specified.

cmd/changelog-gen/changelog-entry.tmpl renamed to cmd/changelog-entry/changelog-entry.tmpl

@@ -12,6 +12,7 @@ import (
 	"github.com/hashicorp/go-changelog"
 	"github.com/manifoldco/promptui"
 	"os"
+	"path"
 	"regexp"
 	"strings"
 	"text/template"
@@ -39,7 +40,7 @@ func main() {
 		fmt.Fprintln(os.Stderr, err)
 		os.Exit(1)
 	}
-	var subcategory, changeType, description, changelogTmpl, url string
+	var subcategory, changeType, description, changelogTmpl, dir, url string
 	var pr int
 	var Url bool
 	flag.BoolVar(&Url, "add-url", false, "add GitHub issue URL (omitted by default due to formatting in changelog-build)")
@@ -48,6 +49,7 @@ func main() {
 	flag.StringVar(&changeType, "type", "", "the type of change")
 	flag.StringVar(&description, "description", "", "the changelog entry content")
 	flag.StringVar(&changelogTmpl, "changelog-template", "", "the path of the file holding the template to use for the changelog entries")
+	flag.StringVar(&dir, "dir", "", "the relative path from the current directory of where the changelog entry file should be written")
 	flag.Parse()
 
 	if pr == -1 {
@@ -128,7 +130,8 @@ func main() {
 	if err != nil {
 		os.Exit(1)
 	}
-	filepath := fmt.Sprintf("%s/%d.txt", pwd, pr)
+	filename := fmt.Sprintf("%d.txt", pr)
+	filepath := path.Join(pwd, dir, filename)
 	err = os.WriteFile(filepath, buf.Bytes(), 0644)
 	if err != nil {
 		os.Exit(1)