corrected UpdateChangelog logic

Author: michalChrobot

Tools/scripts/ReleaseAutomation/commitNetcodeChangelogAndPackageVersionUpdates.py

@@ -69,7 +69,7 @@ def updateNetcodeChangelogAndPackageVersionAndPush():
         repo.git.pull("origin", ngo_default_repo_branch_to_push_to)
 
         # Update the changelog file with adding new [Unreleased] section
-        update_changelog(ngo_package_version, ngo_package_name, add_unreleased_template=True)
+        update_changelog(ngo_changelog_path, ngo_package_version, ngo_package_name, add_unreleased_template=True)
         # Update the package version by patch to represent the "current package state" after release
         update_package_version_by_patch(ngo_manifest_path)
 

Tools/scripts/ReleaseAutomation/triggerYamatoJobsForNetcodeReleaseValidation.py

@@ -126,7 +126,7 @@ def trigger_automated_builds_job_on_yamato(yamato_api_token, project_id, branch_
 
 
 def trigger_NGO_release_preparation_jobs():
-    """Triggers Wrench dry run promotion josb and build automation for anticipation for Playtesting and Packageworks setup for NGO."""
+    """Triggers Wrench dry run promotion jobs and build automation for anticipation for Playtesting and Packageworks setup for NGO."""
 
     samples_to_build = [
         {

Tools/scripts/Utils/general_utils.py

@@ -5,8 +5,6 @@
 import re
 import datetime
 
-from config import getPackageChangelogPath
-
 UNRELEASED_CHANGELOG_SECTION_TEMPLATE = r"""
 ## [Unreleased]
 
@@ -108,7 +106,7 @@ def update_validation_exceptions(validation_file, package_version):
         json_file.write("\n")  # Add newline cause Py JSON does not
         print(f"  updated `{validation_file}`")
 
-def update_changelog(new_version, add_unreleased_template=False):
+def update_changelog(changelog_path, new_version, add_unreleased_template=False):
     """
     Cleans the [Unreleased] section of the changelog by removing empty subsections,
     then replaces the '[Unreleased]' tag with the new version and release date.
@@ -123,11 +121,6 @@ def update_changelog(new_version, add_unreleased_template=False):
 
     new_changelog_entry = f'## [{new_version}] - {datetime.date.today().isoformat()}'
     version_header_to_find_if_exists = f'## [{new_version}]'
-    changelog_path = getPackageChangelogPath()
-
-    if not os.path.exists(changelog_path):
-        print("CHANGELOG path is incorrect, the script will terminate without updating the CHANGELOG")
-        return None
 
     with open(changelog_path, 'r', encoding='UTF-8') as f:
         changelog_text = f.read()
@@ -169,5 +162,3 @@ def update_changelog(new_version, add_unreleased_template=False):
     # Write the changes
     with open(changelog_path, 'w', encoding='UTF-8') as file:
         file.write(final_content)
-
-    return final_content

Tools/scripts/release.py

@@ -12,19 +12,25 @@
 UTILS_DIR = os.path.abspath(os.path.join(os.path.dirname(__file__), './Utils'))
 sys.path.insert(0, UTILS_DIR)
 from general_utils import get_package_version_from_manifest, update_changelog, update_validation_exceptions # nopep8
-from config import getNetcodePackageName, getPackageManifestPath, getPackageValidationExceptionsPath # nopep8
+from config import getNetcodePackageName, getPackageManifestPath, getPackageValidationExceptionsPath, getPackageChangelogPath # nopep8
 
 if __name__ == '__main__':
 
     ngo_package_name = getNetcodePackageName()
     ngo_manifest_path = getPackageManifestPath()
     ngo_validation_exceptions_path = getPackageValidationExceptionsPath()
-    ngo_package_version = get_package_version_from_manifest(ngo_manifest_path)
+    ngo_changelog_path = getPackageChangelogPath()
 
     if not os.path.exists(ngo_manifest_path):
         print(f" Path does not exist: {ngo_manifest_path}")
         sys.exit(1)
 
+    if not os.path.exists(ngo_changelog_path):
+        print(f" Path CHANGELOG does not exist: {ngo_changelog_path}")
+        sys.exit(1)
+
+    ngo_package_version = get_package_version_from_manifest(ngo_manifest_path)
+
     if ngo_package_version is None:
         print(f"Package version not found at {ngo_manifest_path}")
         sys.exit(1)
@@ -34,4 +40,4 @@
     update_validation_exceptions(ngo_validation_exceptions_path, ngo_package_version)
     # Clean the CHANGELOG and add latest entry
     # package version is already know as is always corresponds to current package state
-    update_changelog(ngo_package_version)
+    update_changelog(ngo_changelog_path, ngo_package_version)