ci: [Backport] Corrections to release automation (#3745)

* ci: Corrections to release automation (#3737)

* Ser release frequency to 10 AM on Sunday's

* Make the release fail silently when release conditions are not met

* Added possibility of a manual trigger that is disregarding the release date

* Removed standards failure about "Using directive is unnecessary"

* Revert "Removed standards failure about "Using directive is unnecessary""

This reverts commit 722b5b9.

* Updated wrench

* temp update of BossRoom branch + TargetFramework update

* Updated typo in cmb tests runAll definition

* Added wrench regeneration step to the release automation

* removed apparently unnecessary directive

* surpressed standards check complaint

* validation correction

* typo

* release trigger name correction

* added missed import

* typo

* corrected script name

* missing import

Author: michalChrobot

.yamato/ngo-publish.yml

@@ -4,7 +4,7 @@ ngo_release_preparation:
   triggers:
     recurring:
       - branch: develop # We make new releases from this branch
-        frequency: weekly # Run at some point every Saturday. Note that it's restricted to every 4th Saturday inside the script
+        frequency: "10 * * 1" # Runs every Sunday at 10:00 AM
   rerun: always
   commands:
     - pip install PyGithub

Tools/scripts/ReleaseAutomation/release_config.py

@@ -39,9 +39,9 @@ def __init__(self):
         self.yamato_project_id = '1201'
         self.command_to_run_on_release_branch = make_package_release_ready
 
-        self.release_weekday = 5  # Saturday
+        self.release_weekday = 6  # Sunday
         self.release_week_cycle = 4  # Release every 4 weeks
-        self.anchor_date = datetime.date(2025, 7, 19) # Anchor date for the release cycle (previous release Saturday)
+        self.anchor_date = datetime.date(2025, 7, 20) # Anchor date for the release cycle (previous release Sunday)
 
         self.package_version = get_package_version_from_manifest(self.manifest_path)
         self.release_branch_name = f"release/{self.package_version}" # Branch from which we want to release

Tools/scripts/ReleaseAutomation/run_release_preparation.py

@@ -18,7 +18,14 @@ def PrepareNetcodePackageForRelease():
 
         print("\nStep 1: Verifying release conditions...")
         verifyReleaseConditions(config)
-
+    except Exception as e:
+        print("\n--- Release conditions were not met ---", file=sys.stderr)
+        print(f"Reason: {e}", file=sys.stderr)
+        sys.exit(0) # In this case we want the job not to fail because this will be an intended blocking behavior
+    
+    
+    
+    try:
         print("\nStep 2: Creating release branch...")
         create_branch_execute_commands_and_push(config)
 

Tools/scripts/Utils/general_utils.py

@@ -4,6 +4,8 @@
 import os
 import re
 import datetime
+import platform
+import subprocess
 
 UNRELEASED_CHANGELOG_SECTION_TEMPLATE = r"""
 ## [Unreleased]
@@ -75,6 +77,42 @@ def update_package_version_by_patch(package_manifest_path):
     return new_package_version
 
 
+def regenerate_wrench():
+    """
+    It runs Tools/regenerate-ci.cmd OR Tools/regenerate-ci.sh script
+    to regenerate the CI files. (depending on the OS)
+    
+    This is needed because wrench scripts content is created dynamically depending on the available editors
+    """
+
+    # --- Regenerate the CI files ---
+    print("\nRegenerating CI files...")
+    script_path = ""
+    if platform.system() == "Windows":
+        script_path = os.path.join('Tools', 'CI', 'regenerate.bat')
+    else: # macOS and Linux
+        script_path = os.path.join('Tools', 'CI', 'regenerate.sh')
+
+    if not os.path.exists(script_path):
+        print(f"Error: Regeneration script not found at '{script_path}'.")
+        return
+
+    try:
+        # Execute the regeneration script
+        # On non-Windows systems, the script might need execute permissions.
+        if platform.system() != "Windows":
+            os.chmod(script_path, 0o755)
+
+        print(f"Running '{script_path}'...")
+        subprocess.run([script_path], check=True, shell=True)
+        print("CI regeneration completed successfully.")
+
+    except subprocess.CalledProcessError as e:
+        print(f"Error: The CI regeneration script failed with exit code {e.returncode}.")
+    except Exception as e:
+        print(f"An unexpected error occurred while running the regeneration script: {e}")
+        
+        
 def update_validation_exceptions(validation_file, package_version):
     """
     Updates the ValidationExceptions.json file with the new package version.

Tools/scripts/Utils/verifyReleaseConditions.py

@@ -4,6 +4,7 @@
 The script will check the following conditions:
 1. **Is today a release day?**
     - The script checks if today is a specified in ReleaseConfig weekday that falls on the release cycle of the team.
+    - Note that if the job is triggered manually, this condition will be bypassed.
 2. **Is the [Unreleased] section of the CHANGELOG.md not empty?**
     - The script checks if the [Unreleased] section in the CHANGELOG.md contains meaningful entries.
 3. **Does the release branch already exist?**
@@ -21,6 +22,17 @@
 import re
 from release_config import ReleaseConfig
 
+def get_yamato_trigger_type():
+    """
+    Retrieves the trigger type for the current Yamato job from environment variables.
+    In other words, we can check if the job was triggered manually, by a schedule, or by a PR, etc.
+    This value is set to Recurring when triggered by automation
+    """
+    trigger_type = os.environ.get('YAMATO_TRIGGER_TYPE', 'Manual')
+    
+    return trigger_type
+
+
 def is_release_date(weekday, release_week_cycle, anchor_date):
     """
     Checks if today is a weekday that falls on the release_week_cycle starting from anchor_date .
@@ -100,7 +112,10 @@ def verifyReleaseConditions(config: ReleaseConfig):
     ]
 
     try:
-        if not is_release_date(config.release_weekday, config.release_week_cycle, config.anchor_date):
+        trigger_type = get_yamato_trigger_type()
+        is_manual = trigger_type in {"Manual", "AdHoc"}
+        
+        if not is_manual and not is_release_date(config.release_weekday, config.release_week_cycle, config.anchor_date):
             error_messages.append(f"Condition not met: Today is not the scheduled release day. It should be weekday: {config.release_weekday}, every {config.release_week_cycle} weeks starting from {config.anchor_date}.")
 
         if is_changelog_empty(config.changelog_path, exceptions):
@@ -114,7 +129,7 @@ def verifyReleaseConditions(config: ReleaseConfig):
             for i, msg in enumerate(error_messages, 1):
                 print(f"{i}. {msg}")
             print("\nJob will not run. Exiting.")
-            sys.exit(1)
+            sys.exit(0)
 
     except Exception as e:
         print("\n--- ERROR: Release Verification failed ---", file=sys.stderr)

Tools/scripts/release.py

@@ -13,7 +13,7 @@
 import subprocess
 import platform
 
-from Utils.general_utils import get_package_version_from_manifest, update_changelog, update_validation_exceptions # nopep8
+from Utils.general_utils import get_package_version_from_manifest, update_changelog, update_validation_exceptions, regenerate_wrench # nopep8
 
 def make_package_release_ready(manifest_path, changelog_path, validation_exceptions_path, package_version):
 
@@ -36,6 +36,8 @@ def make_package_release_ready(manifest_path, changelog_path, validation_excepti
     # package version is already know as explained in
     # https://github.cds.internal.unity3d.com/unity/dots/pull/14318
     update_changelog(changelog_path, package_version)
+    # Make sure that the wrench scripts are up to date
+    regenerate_wrench()
 
 
 if __name__ == '__main__':

com.unity.netcode.gameobjects/Runtime/NetworkVariable/ResizableBitVector.cs

@@ -1,6 +1,12 @@
 using System;
 using Unity.Collections;
+
+// The following gets complained on by standards check that is
+// likely not analyzing extension method usage deeply enough and thinks the using directive is unused.
+// The directive is required for GetUnsafePtr() to be available.
+#pragma warning disable IDE0005
 using Unity.Collections.LowLevel.Unsafe;
+#pragma warning restore IDE0005
 
 namespace Unity.Netcode
 {

dotnet-tools/netcode.standards/netcode.standards.csproj

@@ -2,7 +2,7 @@
 
     <PropertyGroup>
         <OutputType>Exe</OutputType>
-        <TargetFramework>net6.0</TargetFramework>
+        <TargetFramework>net8.0</TargetFramework>
         <PackAsTool>true</PackAsTool>
         <ToolCommandName>netcode.standards</ToolCommandName>
         <PackageOutputPath>./nupkg</PackageOutputPath>