Add option to pass a version message

kovetskiy · Apr 11, 2024 · 9b91ee3 · 9b91ee3
1 parent b7cb182
commit 9b91ee3
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/main.go b/main.go
@@ -84,6 +84,12 @@ var flags = []cli.Flag{
 		Usage:   "don't send notifications while updating Confluence page.",
 		EnvVars: []string{"MARK_MINOR_EDIT"},
 	}),
+	altsrc.NewStringFlag(&cli.StringFlag{
+		Name:    "version-message",
+		Value:   "",
+        Usage:   "add a message to the page version, to explain the edit (default: \"\")",
+		EnvVars: []string{"MARK_VERSION_MESSAGE"},
+	}),
 	altsrc.NewStringFlag(&cli.StringFlag{
 		Name:    "color",
 		Value:   "auto",
@@ -511,7 +517,7 @@ func processFile(
 		html = buffer.String()
 	}
 
-	err = api.UpdatePage(target, html, cCtx.Bool("minor-edit"), meta.Labels, meta.ContentAppearance)
+	err = api.UpdatePage(target, html, cCtx.Bool("minor-edit"), cCtx.String("version-message"), meta.Labels, meta.ContentAppearance)
 	if err != nil {
 		log.Fatal(err)
 	}

diff --git a/pkg/confluence/api.go b/pkg/confluence/api.go
@@ -503,7 +503,7 @@ func (api *API) CreatePage(
 	return request.Response.(*PageInfo), nil
 }
 
-func (api *API) UpdatePage(page *PageInfo, newContent string, minorEdit bool, newLabels []string, appearance string) error {
+func (api *API) UpdatePage(page *PageInfo, newContent string, minorEdit bool, versionMessage string, newLabels []string, appearance string) error {
 	nextPageVersion := page.Version.Number + 1
 	oldAncestors := []map[string]interface{}{}
 
@@ -532,6 +532,7 @@ func (api *API) UpdatePage(page *PageInfo, newContent string, minorEdit bool, ne
 		"version": map[string]interface{}{
 			"number":    nextPageVersion,
 			"minorEdit": minorEdit,
+			"message":   versionMessage,
 		},
 		"ancestors": oldAncestors,
 		"body": map[string]interface{}{