corrected command and release script

Author: michalChrobot

.yamato/package-pack.yml

@@ -37,7 +37,7 @@ package_pack_-_ngo_{{ platform.name }}:
   variables:
     XRAY_PROFILE: "supported ./pvpExceptions.json"
   commands:
-    - Tools\scripts\release.py # Needed to ensure that CHANGELOG is properly formatted for this test due to the fact that we have bumped package version (to properly perform vetting tests)
+    - python Tools/scripts/release.py # Needed to ensure that CHANGELOG is properly formatted for this test due to the fact that we have bumped package version (to properly perform vetting tests)
     - upm-pvp pack "com.unity.netcode.gameobjects" --output upm-ci~/packages
     - upm-pvp xray --packages "upm-ci~/packages/com.unity.netcode.gameobjects*.tgz" --results pvp-results
     - upm-pvp require {% if platform.name == "win" %}"%XRAY_PROFILE%"{% else %}"$XRAY_PROFILE"{% endif %} --results pvp-results --allow-missing

.yamato/vetting-test.yml

@@ -10,7 +10,7 @@ vetting_test:
   name: MP Tools - Vetting Test (Win, {{editor}} LTS)
   agent: { type: Unity::VM, flavor: b1.large, image: package-ci/win11:v4 }
   commands:
-    - Tools\scripts\release.py # Needed to ensure that CHANGELOG is properly formatted for this test
+    - python Tools/scripts/release.py # Needed to ensure that CHANGELOG is properly formatted for this test
     - npm install -g "upm-ci-utils@stable" --registry https://artifactory.prd.it.unity3d.com/artifactory/api/npm/upm-npm
     - unity-downloader-cli --fast --wait --unity-version {{ editor }} --components editor --arch x64
     - upm-ci package pack --package-path com.unity.netcode.gameobjects

Tools/scripts/release.py

@@ -12,14 +12,25 @@
 
 def update_changelog(new_version):
     changelog_entry = f'## [{new_version}] - {datetime.date.today().isoformat()}'
-
+    changelog_path = f'{package_name}/CHANGELOG.md'
     print(changelog_entry)
+    
+    if not os.path.exists(changelog_path):
+        print(f"Error: CHANGELOG.md file not found at {changelog_path}")
+        return
 
-    changelog_path = f'{package_name}/CHANGELOG.md'
     with open(changelog_path, 'rb') as f:
         changelog_text = f.read()
-
-    changelog_text = re.sub(br'## \[Unreleased\]', bytes(changelog_entry, 'UTF-8'), changelog_text)
+    
+    changelog_text_decoded = changelog_text.decode("utf-8")
+    if '## [Unreleased]' in changelog_text_decoded:
+        # Replace the `Unreleased` section with the new version entry
+        print("Found `## [Unreleased]` section. Updating it.")
+        changelog_text = re.sub(br'## \[Unreleased\]', bytes(changelog_entry, 'UTF-8'), changelog_text)
+    else:
+        # `Unreleased` section does not exist, so prepend the new entry at the top
+        print("No `## [Unreleased]` section found. Prepending the new entry.")
+        changelog_text = bytes(f"{changelog_entry}\n\n", 'UTF-8') + changelog_text
 
     with open(changelog_path, 'wb') as f:
         f.write(changelog_text)
@@ -59,6 +70,7 @@ def get_manifest_json_version(filename):
     return data['version']
 
 if __name__ == '__main__':
+    print(f"Current working directory: {os.getcwd()}")
     manifest_path = f'{package_name}/package.json'
     version = get_manifest_json_version(manifest_path)
     update_validation_exceptions(version)