publisher: ensure new pages include a configured version comment

When a user configures `confluence_version_comment`, the value used will
only show in a page's history for page updates. This is due to the
original implementation only populate the version message for page
updates. This commit adjusts the implementation to always populate a
`version` entry for a page with a configured message value.

Note that new page comments only appear to work on Confluence Cloud.
Tests with Confluence server (v7.19.x) does not appear to accept a
message value (ignored?).

Signed-off-by: James Knight <[email protected]>

Author: jdknight

sphinxcontrib/confluencebuilder/publisher.py

@@ -931,6 +931,10 @@ def _build_page(self, page_name, data):
             'space': {
                 'key': self.space_key,
             },
+            'version': {
+                'number': 1,
+                'message': self.config.confluence_version_comment,
+            },
         }
 
         if self.editor:
@@ -972,10 +976,7 @@ def _update_page(self, page, page_name, data, parent_id=None):
 
         update_page = self._build_page(page_name, data)
         update_page['id'] = page['id']
-        update_page['version'] = {
-            'number': last_version + 1,
-            'message': self.config.confluence_version_comment,
-        }
+        update_page['version']['number'] = last_version + 1
 
         labels = list(data['labels'])
         if self.append_labels: