Merge pull request #762 from sphinx-contrib/write-change-comment-for-new-pages

publisher: ensure new pages include a configured version comment

Author: jdknight

doc/configuration.rst

@@ -1557,6 +1557,14 @@ Advanced publishing configuration
 .. confval:: confluence_version_comment
 
     .. versionadded:: 1.8
+    .. versionchanged:: 2.1
+
+        Support comments for first/new pages on Confluence Cloud.
+
+    .. note::
+
+        Confluence Server/DC does not support setting a version comment for
+        the first/new page revision.
 
     A string value to be added as a comment to Confluence's version history.
 

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: