ci: Update for Netcode Release Automation

[michalChrobot]

Purpose of this PR

This PR aims to follow up on some issues discovered while using Release Automation for Netcode releases

1. I re-enabled the job trigger that was disabled in ci: Temporarily disabled trigger for release automation #3829
2. I updated pr-description-validation check to not block PRs created by bots (namely prefixed with svc- or unity-renovate
3. I updated regenerate-ci scripts to unify this with N4E approach and made sure that recipes are correctly regenerated for release branch. This is needed because new Editors for validation are fetched dynamically upon recipe regeneration so always worth to double check
4. I decided to modify the action of updating the default branch (Example here) from directly committing changes to creating a PR with them. This helps to address several flaws like:

• We had issues before with branch protection rules that would block the commit from landing due to required checks or reviews
• It will be easier to test this solution or revert it's effects when we don't want to release. Currently we can delete the release branch that was created but to revert the commit we have to push another one. Now if we don't want to proceed with the release OR we want to test the automation by triggering it manually we can just delete the release branch and close the PR to default branch which won't mess around too much

Jira ticket

https://jira.unity3d.com/browse/MTT-14251

Documentation

I will modify Release Automation doc to reflect this change

Testing & QA (How your changes can be verified during release Playtest)

I will run the automation from this branch.

• See created PR and branch in chore: Updated aspects of Netcode package in anticipation of v2.8.1 release #3832
• See green job in https://unity-ci.cds.internal.unity3d.com/job/61350653

Backports

#3828

[michalChrobot]

/review

[u-pr]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis 🔶 MTT-12841 - Partially compliant Compliant requirements: Create a release branch after Bug Week as a hard deadline for changes included in that release. Run scripts to update CHANGELOG and perform other manual release-prep steps automatically. Trigger builds/validation needed for playtesting after branch creation. Non-compliant requirements: Automate Netcode package release process steps via a Yamato job running on a schedule aligned with the sprint cadence. Requires further human verification: Provide clearer guidance and documentation around the automated release flow and deadlines.

⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪ Moderate-sized CI/release automation changes touching git operations, GitHub API usage, and release scripts that require careful validation of failure modes.

🏅 Score: 82 Solid improvements (PR-based updates, better error handling) but a few correctness/robustness issues around error messages, shell invocation, and hard-coded reviewers need tightening.

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Hard-coding The PR reviewer and PR metadata are hard-coded in config (e.g., pr_reviewers = ["michal-chrobot"]), which can break automation for forks/ownership changes; consider sourcing reviewers from env/config or making it optional and defaulting to no review request. self.release_commit_message = f"Updated changelog and package version for Netcode in anticipation of v{self.package_version} release" self.pr_branch_name = f"netcode-update-after-{self.package_version}-release-branch-creation" # Branch from which we will create PR to default branch with relevant changes after release branch is created self.pr_commit_message = f"chore: Updated aspects of Netcode package in anticipation of v{self.package_version} release" self.pr_body = f"This PR was created in sync with branching of {self.release_branch_name}. It includes changes that should land on the default Netcode branch ({self.default_repo_branch}) to reflect the new state of the package after the v{self.package_version} release:\n" \ f"1) Updated CHANGELOG.md by adding new [Unreleased] section template at the top and cleaning the Changelog for the current release.\n" \ f"2) Updated package version in package.json by incrementing the patch version to signify the current state of the package.\n" \ f"3) Updated package version in ValidationExceptions.json to match the new package version.\n\n" \ f"Please review and merge this PR to keep the default branch up to date with the latest package state after the release. Those changes can land immediately OR after the release was finalized but make sure that the Changelog will be merged correctly as sometimes some discrepancies may be introduced due to new entries being introduced meantime\n" self.pr_reviewers = ["michal-chrobot"] Shell invocation subprocess.run([script_path], shell=True) is an odd combination and may behave differently across platforms/agents; prefer shell=False with a list, or shell=True with a string command, and consider capturing/printing stdout/stderr on failure for diagnosability in CI. 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', 'regenerate-ci.cmd') else: # macOS and Linux script_path = os.path.join('Tools', 'regenerate-ci.sh') if not os.path.exists(script_path): raise FileNotFoundError(f"Error: Regeneration script not found at '{script_path}'.") try: # Execute the regeneration script # On non-Windows systems, the script might need execute permissions. if platform.system() != "Windows": os.chmod(script_path, 0o755) subprocess.run([script_path], check=True, shell=True) except subprocess.CalledProcessError as e: raise Exception(f"Error: The CI regeneration script failed with exit code {e.returncode}.") except Exception as e: raise Exception(f"An unexpected error occurred while running the regeneration script: {e}") Error handling get_package_version_from_manifest now raises FileNotFoundError with a typo ("couldn't be find") and update_validation_exceptions/update_changelog now use warnings.warn, which may be easy to miss in CI logs; consider clearer exception text and/or explicit logging when warnings should be actionable. raise FileNotFoundError(f"{package_manifest_path} couldn't be find") with open(package_manifest_path, 'rb') as f: json_text = f.read() data = json.loads(json_text) return data['version'] def update_package_version_by_patch(package_manifest_path): """ Updates the package version in the package.json file. This function will bump the package version by a patch. The usual usage would be to bump package version during/after release to represent the "current package state" which progresses since the release branch was created """ if not os.path.exists(package_manifest_path): raise FileNotFoundError(f"The file {package_manifest_path} does not exist.") with open(package_manifest_path, 'r', encoding='UTF-8') as f: package_manifest = json.load(f) version_parts = get_package_version_from_manifest(package_manifest_path).split('.') if len(version_parts) != 3: raise ValueError("Version format is not valid. Expected format: 'major.minor.patch'.") # Increment the patch version version_parts[2] = str(int(version_parts[2]) + 1) new_package_version = '.'.join(version_parts) package_manifest['version'] = new_package_version with open(package_manifest_path, 'w', encoding='UTF-8', newline='\n') as f: json.dump(package_manifest, f, indent=4) return new_package_version def update_validation_exceptions(validation_file, package_version): """ Updates the ValidationExceptions.json file with the new package version. """ # If files do not exist, exit if not os.path.exists(validation_file): return # Update the PackageVersion in the exceptions with open(validation_file, 'rb') as f: json_text = f.read() data = json.loads(json_text) updated = False for exceptionElements in ["WarningExceptions", "ErrorExceptions"]: exceptions = data.get(exceptionElements) if exceptions is None: continue for exception in exceptions: if 'PackageVersion' in exception: exception['PackageVersion'] = package_version updated = True # If no exceptions were updated, we do not need to write the file if not updated: warnings.warn(f"No validation exceptions were updated in {validation_file}.") return with open(validation_file, 'w', encoding='UTF-8', newline='\n') as json_file: json.dump(data, json_file, ensure_ascii=False, indent=2) json_file.write("\n") # Add newline cause Py JSON does not 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. If the version header already exists, it will remove the [Unreleased] section and add any entries under the present version. If add_unreleased_template is specified then it will also include the template at the top of the file 1 - Cleans the [Unreleased] section by removing empty subsections. 2 - Checks if the version header already has its section in the changelog. 3 - If it does, it removes the [Unreleased] section and its content. 4 - If it does not, it replaces the [Unreleased] section with the new version and today's date. """ new_changelog_entry = f'## [{new_version}] - {datetime.date.today().isoformat()}' version_header_to_find_if_exists = f'## [{new_version}]' with open(changelog_path, 'r', encoding='UTF-8') as f: changelog_text = f.read() # This pattern finds a line starting with '###', followed by its newline, # and then two more lines that contain only whitespace. # The re.MULTILINE flag allows '^' to match the start of each line. pattern = re.compile(r"^###.*\n\n\n", re.MULTILINE) # Replace every match with an empty string. The goal is to remove empty CHANGELOG subsections. cleaned_content = pattern.sub('', changelog_text) if version_header_to_find_if_exists in changelog_text: warnings.warn(f"A changelog entry for version '{new_version}' already exists. The script will just remove Unreleased section and its content.") changelog_text = re.sub(r'(?s)## \[Unreleased(.*?)(?=## \[)', '', changelog_text)

Update review

---

🤖 Helpful? Please react with 👍/👎 | Questions❓Please reach out in Slack #ask-u-pr-agent