(DOCS-15722): 4.4.18 initial changelog and changelog script fixes (#2117)

jeff-allen-mongo · web-flow · commit b7569a63983c · 2022-11-04T15:22:00.000-04:00
* (DOCS-15722): 4.4.18 initial changelog

* fix bug with changelog output

* refactoring

* regenerate 4.4.18 changelog

* fix typo
diff --git a/changelogs/generatechangelogs.py b/changelogs/generatechangelogs.py
@@ -1,9 +1,9 @@
 import collections
 import logging
 import os
-import rstcloth.rstcloth as rstcloth
 import yaml
 from jira import JIRA
+from rstcloth import RstCloth
 
 logger = logging.getLogger('generatechangelogs.py')
 
@@ -123,7 +123,7 @@ def get_issue_structure(config, issues, version):
     return headings
 
 
-def generate_changelog_rst(config, headings, fixVersion):
+def generate_changelog_rst(config, headings, fixVersion, outputFile):
     """
     Generate the changelog rst from the groupings established in
     get_issue_structure()
@@ -135,92 +135,88 @@ def generate_changelog_rst(config, headings, fixVersion):
         for component in sub_headings:
             nested[component] = enclosing_level
 
-    # build the changelog content itself.
-    r = rstcloth.RstCloth()
-    level = 3
+    with open (outputFile, 'w') as f:
+        # build the changelog content itself.
+        r = RstCloth(f)
+        level = 3
 
-    r.ref_target("{0}-changelog".format(fixVersion))
-    r.newline()
-    r.heading(text="{0} Changelog".format(fixVersion), char='-')
-    r.newline()
+        r.ref_target("{0}-changelog".format(fixVersion))
+        r.newline()
+        r.heading(text="{0} Changelog".format(fixVersion), char='-')
+        r.newline()
 
-    # process all of the issues by group.
-    for heading, issues in headings.items():
-        if heading in nested:
-            # we deal with nested headings when we do their parent. skip here.
-            continue
-        else:
-            if heading in config.get('nesting') and len(issues) == 0:
-                # if a heading has subheadings, and all are empty, then we should skip it entirely.
-                empty_sub_headings = 0
-                for sub in config.get('nesting').get(heading):
-                    if len(headings[sub]) == 0:
-                        empty_sub_headings += 1
-                if empty_sub_headings == len(config.get('nesting').get(heading)):
-                    continue
-            elif len(issues) == 0:
-                # skip empty headings.
+        # process all of the issues by group.
+        for heading, issues in headings.items():
+            if heading in nested:
+                # we deal with nested headings when we do their parent. skip here.
                 continue
-
-            # format the heading.
-            r.heading(text=heading, indent=0,
-                      char='~')
-            r.newline()
-
-            if len(issues) == 1:
-                r.content("{1} {0}".format(issues[0][1], r.role(
-                    "issue", issues[0][0])))
             else:
-                for issue in issues:
-                    r.li("{1} {0}".format(issue[1], r.role(
-                        "issue", issue[0])))
-            r.newline()
-
-            # repeat the above formatting with minor variations to do the nesting.
-            if heading in config.get('nesting'):
-                for sub in config.get('nesting').get(heading):
-                    if len(headings[sub]) == 0:
+                if heading in config.get('nesting') and len(issues) == 0:
+                    # if a heading has subheadings, and all are empty, then we should skip it entirely.
+                    empty_sub_headings = 0
+                    for sub in config.get('nesting').get(heading):
+                        if len(headings[sub]) == 0:
+                            empty_sub_headings += 1
+                    if empty_sub_headings == len(config.get('nesting').get(heading)):
                         continue
+                elif len(issues) == 0:
+                    # skip empty headings.
+                    continue
 
-                    r.heading(text=sub, indent=0,
-                              # char=giza.content.helper.character_levels[level+1])
-                              char='`')
-                    r.newline()
-
-                    sub_issues = headings[sub]
-                    if len(sub_issues) == 0:
-                        r.content("{1} {0}".format(sub_issues[0][1].strip(), r.role(
-                            "issue", sub_issues[0][0])))
-                    else:
-                        for issue in sub_issues:
-                            r.li("{1} {0}".format(issue[1].strip(), r.role(
-                                "issue", issue[0])))
-                    r.newline()
-
-    return r
+                # format the heading.
+                r.heading(text=heading, indent=0,
+                        char='~')
+                r.newline()
+
+                if len(issues) == 1:
+                    r.content("{1} {0}".format(issues[0][1], r.role(
+                        "issue", issues[0][0])))
+                else:
+                    for issue in issues:
+                        r.li("{1} {0}".format(issue[1], r.role(
+                            "issue", issue[0])))
+                r.newline()
+
+                # repeat the above formatting with minor variations to do the nesting.
+                if heading in config.get('nesting'):
+                    for sub in config.get('nesting').get(heading):
+                        if len(headings[sub]) == 0:
+                            continue
+
+                        r.heading(text=sub, indent=0,
+                                # char=giza.content.helper.character_levels[level+1])
+                                char='`')
+                        r.newline()
+
+                        sub_issues = headings[sub]
+                        if len(sub_issues) == 0:
+                            r.content("{1} {0}".format(sub_issues[0][1].strip(), r.role(
+                                "issue", sub_issues[0][0])))
+                        else:
+                            for issue in sub_issues:
+                                r.li("{1} {0}".format(issue[1].strip(), r.role(
+                                    "issue", issue[0])))
+                        r.newline()
 
+        print(
+            "wrote changelog '{0}'. Commit this file independently.".format(outputFile))
 
-def write_changelog_file(rst, fixVersion):
 
-    # Output the rst to source/includes/changelogs/releases
+def generate_output_filePath(fixVersion):
     sourceDir = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
     fn = fixVersion + ".rst"
     outputDir = os.path.join(
         sourceDir, "source/includes/changelogs/releases", fn)
 
-    with open (outputDir, 'w') as f:
-        f.write(str(rst))
-
-        logger.info(
-            "wrote changelog '{0}'. Commit this file independently.".format(outputDir))
-
-        print(
-            "wrote changelog '{0}'. Commit this file independently.".format(outputDir))
+    return outputDir
 
 def main():
     # Prompt user for the version to generate the changelog for:
     fixVersion = input("Enter changelog version: ")
 
+    # Generate the outputfile
+    outputFile = generate_output_filePath(fixVersion)
+
     # Get list of JIRA issues to include in changelog
     issues = get_jira_issues(fixVersion)
 
@@ -231,10 +227,10 @@ def main():
     issue_headings = get_issue_structure(config, issues, fixVersion)
 
     # Convert the issue headings into rst
-    changelog_rst = generate_changelog_rst(config, issue_headings, fixVersion)
+    changelog_rst = generate_changelog_rst(config, issue_headings, fixVersion, outputFile)
 
     # Write the changelog to source/includes/changelogs/releases
-    write_changelog_file(changelog_rst, fixVersion)
+    # write_changelog_file(changelog_rst, fixVersion)
 
 if __name__ == "__main__":
     main()
diff --git a/source/includes/changelogs/releases/4.4.18.rst b/source/includes/changelogs/releases/4.4.18.rst
@@ -0,0 +1,88 @@
+.. _4.4.18-changelog:
+
+4.4.18 Changelog
+----------------
+
+Query
+~~~~~
+
+- :issue:`SERVER-50454` Avoiding sending the "keyValue" field to drivers
+  on duplicate key error
+- :issue:`SERVER-66289` $out incorrectly throws BSONObj size error on
+  v5.0.8
+
+Operations
+~~~~~~~~~~
+
+:issue:`SERVER-67793` log_progress_msg in init.d does not print message
+
+Build and Packaging
+~~~~~~~~~~~~~~~~~~~
+
+:issue:`SERVER-48203` Support --install-action for Ninja builds
+
+Internals
+~~~~~~~~~
+
+- :issue:`SERVER-56368` Prohibit running
+  $backupCursor/$backupCursorExtend on an aggregation against a
+  collection
+- :issue:`SERVER-58673` Enable featureFlagPerShardCursor
+- :issue:`SERVER-61185` Use prefix_search for unique index lookup
+- :issue:`SERVER-62400` Add $_passthroughToShard parameter to
+  AggregateCommandRequest
+- :issue:`SERVER-62681` Create change streams per shard cursor
+  passthrough suite
+- :issue:`SERVER-62738` Give mongos the ability to passthrough to a
+  specific shard
+- :issue:`SERVER-63585` Fastcount gets out of sync when a delete
+  rollbacks and another transaction deletes the same rows
+- :issue:`SERVER-63772` Post Batch Resume token not sent on initial
+  batch from per shard cursor change stream
+- :issue:`SERVER-63773` Per Shard cursor post batch resume token not set
+  in getMore responses
+- :issue:`SERVER-63774` Pass optional dbVersion to
+  runPipelineOnSpecificShard
+- :issue:`SERVER-63781` $sortKey not filtered out in initial batch from
+  post batch resume token
+- :issue:`SERVER-68115` Bug fix for "elemMatchRootLength > 0" invariant
+  trigger
+- :issue:`SERVER-68126` Check for negative maxChunkSize input value in
+  AutoSplitVector
+- :issue:`SERVER-68470` Amazon Linux 4.2/4.4 RPMs fail to install due to
+  missing shadow-utils
+- :issue:`SERVER-69003` [4.4] backport pm-2419 Per Shard Cursors via
+  mongos
+- :issue:`SERVER-69133` remove redundant setting of hardlink install
+  action
+- :issue:`SERVER-69281` Force minimum ninja version
+- :issue:`SERVER-69348` Commands must declare empty auth checks to be
+  universally callable
+- :issue:`SERVER-69389` Command checkAuthorization may throw
+  ErrorCodes::NamespaceNotFound for existing collection while trying to
+  resolve UUID to namespace when the node is  shutting down.
+- :issue:`SERVER-69443` [4.4] Allow speculative majority reads in
+  multi-doc txns when --enableMajorityReadConcern=false
+- :issue:`SERVER-69446` Increase electionTimeoutMillis in
+  jstests/replsets/dbcheck_write_concern.js
+- :issue:`SERVER-69569` Python scripts failing in Evergreen tasks
+- :issue:`SERVER-69785` robustify change_streams_per_shard_cursor.js
+- :issue:`SERVER-69868` Return an error when starting a TransportLayer
+  that is shutdown
+- :issue:`SERVER-69912` SConstruct is executable by mistake
+- :issue:`SERVER-70299` Remove JSON.send command usage
+- :issue:`SERVER-70348` Remove EAGAIN for queryable WT and retry
+  internally
+- :issue:`SERVER-70398` Handle case when execution doesn't exist
+- :issue:`SERVER-70469` Use virtual env python in watchdog tests
+- :issue:`SERVER-70483` Update Resmoke to pass "evergreen_execution" up
+  to logkeeper.
+- :issue:`SERVER-70484` Remove signal processing module from perf.yml
+  and sys_perf.yml
+- :issue:`SERVER-70633` Make per shard cursors suite actually run tests
+  in 5.0
+- :issue:`SERVER-70938` Remove --system-site-packages from virtual env
+  setup
+- :issue:`WT-7912` Fix prefix search near optimisation to handle
+  scenarios where the key range is split across pages.
+
diff --git a/source/release-notes/4.4-changelog.txt b/source/release-notes/4.4-changelog.txt
@@ -10,6 +10,8 @@
    :depth: 1
    :class: singlecol
 
+.. include:: /includes/changelogs/releases/4.4.18.rst
+
 .. include:: /includes/changelogs/releases/4.4.17.rst
 
 .. include:: /includes/changelogs/releases/4.4.16.rst
diff --git a/source/release-notes/4.4.txt b/source/release-notes/4.4.txt
@@ -13,6 +13,28 @@ Release Notes for MongoDB 4.4
 Patch Releases
 --------------
 
+.. _4.4.18-release-notes:
+
+4.4.18 - Upcoming
+~~~~~~~~~~~~~~~~~
+
+Issues fixed:
+
+- :issue:`SERVER-66289` $out incorrectly throws BSONObj size error on
+  v5.0.8
+- :issue:`SERVER-61185` Use prefix_search for unique index lookup
+- :issue:`SERVER-68115` Bug fix for "elemMatchRootLength > 0" invariant
+  trigger
+- :issue:`SERVER-50454` Avoiding sending the "keyValue" field to drivers
+  on duplicate key error
+- :issue:`SERVER-69443` [4.4] Allow speculative majority reads in
+  multi-doc txns when --enableMajorityReadConcern=false
+
+- `All JIRA issues closed in 4.4.18
+  <https://jira.mongodb.org/issues/?jql=project%20in%20(SERVER%2CTOOLS%2CWT)%20AND%20resolution%3D%27Fixed%27%20and%20fixversion%3D%274.4.18%27>`_
+
+- :ref:`4.4.18-changelog`
+
 .. _4.4.17-release-notes:
 
 4.4.17 - Sep 28, 2022
