nitpicks

Author: michalChrobot

Tools/scripts/ReleaseAutomation/release_config.py

@@ -1,4 +1,6 @@
-import datetime
+"""Netcode configuration for the release process automation."""
+
+import datetime
 import sys
 import os
 from github import Github
@@ -7,8 +9,8 @@
 PARENT_DIR = os.path.abspath(os.path.join(os.path.dirname(__file__), '../'))
 sys.path.insert(0, PARENT_DIR)
 
-from Utils.general_utils import get_package_version_from_manifest # nopep8
-from release import make_package_release_ready # nopep8
+from Utils.general_utils import get_package_version_from_manifest
+from release import make_package_release_ready
 
 class GithubUtils:
     def __init__(self, access_token, repo):

Tools/scripts/ReleaseAutomation/run_release_preparation.py

@@ -1,14 +1,15 @@
-import sys
-import os
+"""Automation for package release process."""
 
 PARENT_DIR = os.path.abspath(os.path.join(os.path.dirname(__file__), '../'))
 sys.path.insert(0, PARENT_DIR)
 
-from ReleaseAutomation.release_config import ReleaseConfig # nopep8
-from Utils.git_utils import create_branch_execute_commands_and_push # nopep8
-from Utils.verifyReleaseConditions import verifyReleaseConditions # nopep8
-from Utils.commitChangelogAndPackageVersionUpdates import commitChangelogAndPackageVersionUpdates # nopep8
-from Utils.triggerYamatoJobsForReleasePreparation import trigger_release_preparation_jobs # nopep8
+import sys
+import os
+from ReleaseAutomation.release_config import ReleaseConfig
+from Utils.git_utils import create_branch_execute_commands_and_push
+from Utils.verifyReleaseConditions import verifyReleaseConditions
+from Utils.commitChangelogAndPackageVersionUpdates import commitChangelogAndPackageVersionUpdates
+from Utils.triggerYamatoJobsForReleasePreparation import trigger_release_preparation_jobs
 
 def PrepareNetcodePackageForRelease():
     try:
@@ -27,7 +28,7 @@ def PrepareNetcodePackageForRelease():
         commitChangelogAndPackageVersionUpdates(config)
 
     except Exception as e:
-        print(f"\n--- ERROR: Netcode release process failed ---", file=sys.stderr)
+        print("\n--- ERROR: Netcode release process failed ---", file=sys.stderr)
         print(f"Reason: {e}", file=sys.stderr)
         sys.exit(1)
 

Tools/scripts/Utils/git_utils.py

@@ -1,13 +1,13 @@
 """Helper class for Git repo operations."""
+
+PARENT_DIR = os.path.abspath(os.path.join(os.path.dirname(__file__), '../ReleaseAutomation'))
+sys.path.insert(0, PARENT_DIR)
+
 import subprocess
 import sys
 import os
 from git import Repo, Actor
 from github import GithubException
-
-PARENT_DIR = os.path.abspath(os.path.join(os.path.dirname(__file__), '../ReleaseAutomation'))
-sys.path.insert(0, PARENT_DIR)
-
 from release_config import ReleaseConfig
 
 def get_local_repo():
@@ -35,10 +35,10 @@ def get_latest_git_revision(branch_name):
         )
         return result.stdout.strip()
 
-    except FileNotFoundError:
-        raise Exception("Git command not found. Please ensure Git is installed and available in your PATH.")
+    except FileNotFoundError as exc:
+        raise Exception("Git command not found. Please ensure Git is installed and available in your PATH.") from exc
     except subprocess.CalledProcessError as e:
-        raise Exception(f"Failed to get the latest revision for branch '{branch_name}'.")
+        raise Exception(f"Failed to get the latest revision for branch '{branch_name}'.") from e
 
 def create_branch_execute_commands_and_push(config: ReleaseConfig):
     """
@@ -57,7 +57,7 @@ def create_branch_execute_commands_and_push(config: ReleaseConfig):
 
         if config.command_to_run_on_release_branch:
             print(f"\nExecuting command on branch '{config.release_branch_name}': {' '.join(config.command_to_run_on_release_branch.__name__)}")
-            config.command_to_run_on_release_branch(config.manifest_path, config.changelog_path, config.validation_exceptions_path, config.package_version)
+            config.command_to_run_on_release_branch(config.manifest_path, config.changelog_path, config.validation_exceptions_path, config.package_version, config.package_name_regex)
 
         repo.git.add('.yamato/') # regenerated jobs
         repo.git.add('Packages/') # for example changelog and package.json updates
@@ -72,6 +72,6 @@ def create_branch_execute_commands_and_push(config: ReleaseConfig):
         print(f"Successfully created, updated and pushed new branch: {config.release_branch_name}")
 
     except GithubException as e:
-        raise GithubException(f"An error occurred with the GitHub API: {e.status}", data=e.data)
+        raise GithubException(f"An error occurred with the GitHub API: {e.status}", data=e.data) from e
     except Exception as e:
-        raise Exception(f"An unexpected error occurred: {e}")
+        raise Exception(f"An unexpected error occurred: {e}") from e

Tools/scripts/Utils/triggerYamatoJobsForReleasePreparation.py

@@ -6,13 +6,13 @@
 Additionally the job also triggers build automation job that will prepare builds for the Playtest.
 """
 #!/usr/bin/env python3
-import os
-import sys
-import requests
 
 PARENT_DIR = os.path.abspath(os.path.join(os.path.dirname(__file__), '../'))
 sys.path.insert(0, PARENT_DIR)
 
+import os
+import sys
+import requests
 from ReleaseAutomation.release_config import ReleaseConfig
 from Utils.git_utils import get_latest_git_revision
 
@@ -44,7 +44,7 @@ def trigger_wrench_promotion_job_on_yamato(yamato_api_token, project_id, branch_
     }
 
     print(f"Triggering job on branch {branch_name}...\n")
-    response = requests.post(YAMATO_API_URL, headers=headers, json=data)
+    response = requests.post(YAMATO_API_URL, headers=headers, json=data, timeout=10)
 
     if response.status_code in [200, 201]:
         data = response.json()
@@ -109,7 +109,7 @@ def trigger_automated_builds_job_on_yamato(yamato_api_token, project_id, branch_
             }
 
             print(f"Triggering the build of {sample['name']} with a configuration '{config['job_name']}' on branch {branch_name}...\n")
-            response = requests.post(YAMATO_API_URL, headers=headers, json=data)
+            response = requests.post(YAMATO_API_URL, headers=headers, json=data, timeout=10)
 
             if not response.status_code in [200, 201]:
                 print(f"Failed to trigger job. Status: {response.status_code}", file=sys.stderr)
@@ -128,6 +128,6 @@ def trigger_release_preparation_jobs(config: ReleaseConfig):
         trigger_automated_builds_job_on_yamato(config.yamato_api_token, config.yamato_project_id, config.release_branch_name, revision_sha, config.yamato_samples_to_build, config.yamato_build_automation_configs)
 
     except Exception as e:
-        print(f"\n--- ERROR: Job failed ---", file=sys.stderr)
+        print("\n--- ERROR: Job failed ---", file=sys.stderr)
         print(f"Reason: {e}", file=sys.stderr)
         sys.exit(1)

Tools/scripts/Utils/verifyReleaseConditions.py

@@ -10,14 +10,14 @@
     - If the release branch for the target release already exists, the script will not run.
 """
 #!/usr/bin/env python3
-import datetime
-import re
-import sys
-import os
 
 PARENT_DIR = os.path.abspath(os.path.join(os.path.dirname(__file__), '../ReleaseAutomation'))
 sys.path.insert(0, PARENT_DIR)
 
+import datetime
+import re
+import sys
+import os
 from release_config import ReleaseConfig
 
 def is_release_date(weekday, release_week_cycle, anchor_date):
@@ -90,6 +90,6 @@ def verifyReleaseConditions(config: ReleaseConfig):
             sys.exit(1)
 
     except Exception as e:
-        print(f"\n--- ERROR: Release Verification failed ---", file=sys.stderr)
+        print("\n--- ERROR: Release Verification failed ---", file=sys.stderr)
         print(f"Reason: {e}", file=sys.stderr)
         sys.exit(1)