Merge branch 'develop-2.0.0' into shadow-package/com.unity.netcode.gameobjects

Author: michalChrobot

.github/workflows/pr-description-validation.yml

@@ -30,17 +30,17 @@ jobs:
             const pr = context.payload.pull_request;
             const body = pr.body || '';
             
-            // List of users to skip description validation
+            // List of user patterns to skip description validation
             // This should be automations where we don't care that much about the description format
-            const skipUsersPrefixes = [
-              'unity-renovate',
-              'svc-'
+            const skipUserPatterns = [
+              /^unity-renovate/,
+              /(^|-)svc(-|$)/
             ];
-            
-            // If PR author is in the skip list, exit early
+
+            // If PR author matches the skip list, exit early
             const author = pr.user.login;
             console.log(`PR author: ${author}`);
-            if (skipUsersPrefixes.some(prefix => author.startsWith(prefix))) {
+            if (skipUserPatterns.some(pattern => pattern.test(author))) {
               console.log(`Skipping PR description check for user: ${author}`);
               return;
             }

.gitignore

@@ -12,3 +12,5 @@ utr.bat
 Tools/CI/bin
 Tools/CI/obj
 
+# Do not include the packages-lock file
+packages-lock.json

.yamato/_run-all.yml

@@ -16,7 +16,7 @@ run_quick_checks:
   name: Run Quick Initial Checks
   dependencies:
     # Ensure the code is running to our current standards
-    - .yamato/project-standards.yml#standards_ubuntu_testproject_{{ validation_editors.default }}
+    - .yamato/project-standards.yml#standards_ubuntu_testproject_{{ validation_editors.standards }}
     # This is needed for most of the jobs to execute tests + it runs xray PVP checks (all fast checks)
     - .yamato/package-pack.yml#package_pack_-_ngo_win
 
@@ -115,7 +115,7 @@ run_all_projects_standards:
   dependencies:
 {% for platform in test_platforms.default -%}
 {% for project in projects.all -%}
-{% for editor in validation_editors.default -%}
+{% for editor in validation_editors.standards -%}
     - .yamato/project-standards.yml#standards_{{ platform.name }}_{{ project.name }}_{{ editor }}
 {% endfor -%}
 {% endfor -%}

.yamato/_triggers.yml

@@ -51,7 +51,7 @@
 pr_minimal_required_checks:
   name: Minimal PR checks
   dependencies:
-    - .yamato/project-standards.yml#standards_ubuntu_testproject_{{ validation_editors.default }}
+    - .yamato/project-standards.yml#standards_ubuntu_testproject_{{ validation_editors.standards }}
     - .yamato/package-pack.yml#package_pack_-_ngo_win
   triggers:
     expression: |-
@@ -89,8 +89,8 @@ pr_code_changes_checks:
     # Note that our daily tests will anyway run both test configurations in "minimal supported" and "trunk" configurations
     - .yamato/desktop-standalone-tests.yml#desktop_standalone_test_testproject_ubuntu_il2cpp_{{ pinnedTrunk }}
     - .yamato/cmb-service-standalone-tests.yml#cmb_service_standalone_test_testproject_ubuntu_il2cpp_{{ pinnedTrunk }}
-    # Run code coverage test
-    - .yamato/code-coverage.yml#code_coverage_ubuntu_{{ validation_editors.default }}
+    # Run code coverage test (PRs use the pinned "safe" trunk)
+    - .yamato/code-coverage.yml#code_coverage_project_test_testproject_ubuntu_{{ pinnedTrunk }}
   triggers:
     expression: |-
       (pull_request.comment eq "ngo" OR
@@ -130,7 +130,7 @@ develop_nightly:
         rerun: always
   dependencies:
     # Run project standards to verify package/default project
-    - .yamato/project-standards.yml#standards_ubuntu_testproject_{{ validation_editors.default }}
+    - .yamato/project-standards.yml#standards_ubuntu_testproject_{{ validation_editors.standards }}
     # Run APV jobs to make sure the change won't break any dependants
     - .yamato/wrench/preview-a-p-v.yml#all_preview_apv_jobs
     # Run package EditMode and Playmode tests on desktop platforms on trunk and 6000.0
@@ -159,8 +159,8 @@ develop_nightly:
     - .yamato/project-updated-dependencies-test.yml#updated-dependencies_testproject_NGO_win_6000.0
     # Run API validation to early-detect all new APIs that would force us to release new minor version of the package. Note that for this to work the package version in package.json must correspond to "actual package state" which means that it should be higher than last released version
     - .yamato/vetting-test.yml#vetting_test
-  # Run code coverage test
-    - .yamato/code-coverage.yml#code_coverage_ubuntu_{{ validation_editors.default }}
+  # Run code coverage test (nightly uses actual trunk)
+    - .yamato/code-coverage.yml#code_coverage_project_test_testproject_ubuntu_trunk
 
 
 # Run all tests on weekly bases

.yamato/code-coverage.yml

@@ -2,33 +2,37 @@
 ---
 
 # DESCRIPTION--------------------------------------------------------------------------
-  # This job is responsible for executing package tests with code coverage analysis enabled.
+  # This job runs the in-repo testproject tests with code coverage analysis enabled.
+  # The project tests also exercise the NGO package tests, so a separate package-test coverage job is not needed.
   # Coverage analysis provides insights into:
     # Test coverage metrics for NGO assemblies
     # Line and branch coverage statistics
     # Generated HTML reports for coverage visualization
     # Additional metrics for coverage analysis
 
 # CONFIGURATION STRUCTURE--------------------------------------------------------------
-  # Jobs are generated using nested loops through:
-    # 1. For default platform only (Ubuntu) since coverage would not vary between platforms (no need for checks on more platforms)
-    # 2. For default editor version (trunk) since coverage would not vary between editors (no need for checks on more editors)
+  # Jobs are generated for:
+    # 1. Default platform only (Ubuntu) since coverage would not vary between platforms (no need for checks on more platforms)
+    # 2. Two editors: actual "trunk" (used by nightly) and the "pinnedTrunk" safe version (used by PRs).
+    #    Occasionally trunk breaks our tests, so PRs run against a pinned "safe" trunk while nightly runs actual trunk.
 
 #TECHNICAL CONSIDERATIONS---------------------------------------------------------------
-  # In theory this job also runs package tests, but we don't want to use it as default since is heavier (because of added coverage analysis) and coverage is not changing that often
   # Requires Unity Editor installation
   # Burst compilation is disabled to ensure accurate coverage measurement
   # In order to properly use -coverage-results-path parameter we need to start it with $PWD (which means the absolute path). Otherwise coverage results will not be visible
 
 # QUALITY CONSIDERATIONS--------------------------------------------------------------------
-  # To see where this job is included (in trigger job definitions) look into _triggers.yml file
-
+  # To see where this job is included (in trigger job definitions) look into _triggers.yml file. Currently:
+    # [Code Coverage] Project Test runs on PR changes (pr_code_changes_checks, pinnedTrunk) and nightly (develop_nightly, trunk)
 
+{% assign coverage_editors = "trunk," | append: pinnedTrunk | split: "," -%}
 
 {% for platform in test_platforms.default -%}
-{% for editor in validation_editors.default -%}
-code_coverage_{{ platform.name }}_{{ editor }}:
-  name: Code Coverage - NGO [{{ platform.name }}, {{ editor }}]
+{% for project in projects.default -%}
+{% for editor in coverage_editors -%}
+{% if editor == "trunk" -%}{% assign editor_label = "trunk" -%}{% else -%}{% assign editor_label = "pinnedTrunk" -%}{% endif -%}
+code_coverage_project_test_{{ project.name }}_{{ platform.name }}_{{ editor }}:
+  name: '[Code Coverage] Project Test - NGO {{ project.name }} [{{ platform.name }}, {{ editor }}]'
   agent:
     type: {{ platform.type }}
     image: {{ platform.image }}
@@ -38,13 +42,14 @@ code_coverage_{{ platform.name }}_{{ editor }}:
 {% endif %}
   commands:
     - unity-downloader-cli --fast --wait -u {{ editor }} -c Editor {% if platform.name == "mac" %} --arch arm64 {% endif %} # For macOS we use ARM64 models
-    - upm-pvp create-test-project test-project --packages "upm-ci~/packages/*.tgz" --unity .Editor
-    - UnifiedTestRunner --suite=editor --suite=playmode --editor-location=.Editor --testproject=test-project --enable-code-coverage --coverage-upload-options="reportsDir:$PWD/test-results/CoverageResults;name:NGOv2_{{ platform.name }}_{{ editor }};flags:NGOv2_{{ platform.name }}_{{ editor }};verbose" --coverage-results-path=$PWD/test-results/CoverageResults --coverage-options="generateHtmlReport;generateAdditionalMetrics;assemblyFilters:+Unity.Netcode.Editor,+Unity.Netcode.Runtime" --extra-editor-arg=--burst-disable-compilation --timeout={{ test_timeout }} --rerun-strategy=Test --retry={{ num_test_retries }} --clean-library-on-rerun --artifacts-path=test-results
+    - UnifiedTestRunner --testproject={{ project.path }} --suite=editor --suite=playmode --editor-location=.Editor --enable-code-coverage --coverage-upload-options="reportsDir:$PWD/test-results/CoverageResults;name:NGOv2_project_{{ project.name }}_{{ platform.name }}_{{ editor_label }};flags:NGOv2_project_{{ project.name }}_{{ platform.name }}_{{ editor_label }};verbose" --coverage-results-path=$PWD/test-results/CoverageResults --coverage-options="generateHtmlReport;generateAdditionalMetrics;assemblyFilters:+Unity.Netcode.Editor,+Unity.Netcode.Runtime" --extra-editor-arg=--burst-disable-compilation --timeout={{ test_timeout }} --rerun-strategy=Test --retry={{ num_test_retries }} --clean-library-on-rerun --artifacts-path=test-results
   artifacts:
     logs:
       paths:
         - "test-results/**/*"
   dependencies:
+    - .yamato/_run-all.yml#run_quick_checks # initial checks to perform fast validation of common errors
     - .yamato/package-pack.yml#package_pack_-_ngo_{{ platform.name }}
 {% endfor -%}
 {% endfor -%}
+{% endfor -%}

.yamato/console-standalone-test.yml

@@ -31,7 +31,6 @@
     # Each console requires specific SDK paths and tools
 
 # QUALITY THOUGHTS--------------------------------------------------------------------
-  # TODO: consider adding all projects that have tests
   # To see where this job is included (in trigger job definitions) look into _triggers.yml file
 
 
@@ -51,16 +50,16 @@ console_standalone_build_{{ project.name }}_{{ platform.name }}_{{ editor }}:
 {% endif %}
   commands:
     - unity-downloader-cli --fast --wait -u {{ editor }} -c Editor -c il2cpp -c {{ platform.name }}
-    - UnifiedTestRunner --testproject={{ project.path }} --architecture={% if platform.name == "switch" %}arm64{% else %}x64{% endif %} --scripting-backend=il2cpp --suite=playmode --platform={{ platform.standalone }} --editor-location=.Editor --artifacts-path=artifacts --player-save-path=build/players --testfilter="Unity.Netcode.RuntimeTests.*" --extra-editor-arg=-batchmode --extra-editor-arg=-nographics --reruncount=1 --clean-library-on-rerun --build-only --timeout={{ test_timeout}}
+    - UnifiedTestRunner --testproject={{ project.path }} --architecture={% if platform.name == "switch" %}arm64{% else %}x64{% endif %} --scripting-backend=il2cpp --suite=playmode --platform={{ platform.standalone }} --editor-location=.Editor --artifacts-path=artifacts --player-save-path=build/players --testfilter="Unity.Netcode.RuntimeTests.*" --extra-editor-arg=-batchmode --extra-editor-arg=-nographics{% if platform.name == "switch" %} --extra-editor-arg=-overrideTextureCompression --extra-editor-arg=ForceUncompressed{% endif %} --reruncount=1 --clean-library-on-rerun --build-only --timeout={{ test_timeout}}
   variables:
 # PS4 related
     SCE_ORBIS_SDK_DIR: 'C:\Users\bokken\SCE\ps4_sdk_12_00'
-# PS5 related --> THIS WAS DISABLED IN PROJECT.METAFILE. SEE MTT-12118
-    SCE_PROSPERO_SDK_DIR: 'C:\Program Files (x86)\SCE\Prospero SDKs\9.000'
-    SHADER_COMPILER_PATH: '${SCE_PROSPERO_SDK_DIR}\target\bins'
+# PS5 related --> win10-ps5:v4 ships SDK 13.000 but defaults SCE_PROSPERO_SDK_DIR to an unsupported version, so set it explicitly.
+    SCE_PROSPERO_SDK_DIR: 'C:\Program Files (x86)\SCE\Prospero SDKs\13.000'
+    SHADER_COMPILER_PATH: '${SCE_PROSPERO_SDK_DIR}\host_tools\bin'
     SCE_ROOT_DIR: 'C:\Program Files (x86)\SCE'
-# Switch related
-    NINTENDO_SDK_ROOT: 'C:\Nintendo\nx_sdk-18_3_0\NintendoSDK'
+# Switch related --> Switch is DISABLED in project.metafile (MTT-15636): 6000.x/trunk editors mandate NintendoSDK 22.2.x, which is not installed on win10-switch:v4 (only nintendosdk-en-21_4_0 is). This target path is correct for when PETS ships 22.2.x and Switch is re-enabled.
+    NINTENDO_SDK_ROOT: 'C:\Nintendo\nintendosdk-en-22_2_0\NintendoSDK'
     UNITY_NINTENDOSDK_CLI_TOOLS: '${NINTENDO_SDK_ROOT}\Tools\CommandLineTools'
   artifacts:
     players:
@@ -94,12 +93,12 @@ console_standalone_test_{{ project.name }}_{{ platform.name }}_{{ editor }}:
   variables:
 # PS4 related
     SCE_ORBIS_SDK_DIR: 'C:\Users\bokken\SCE\ps4_sdk_12_00'
-# PS5 related --> THIS WAS DISABLED IN PROJECT.METAFILE. SEE MTT-12118
-    SCE_PROSPERO_SDK_DIR: 'C:\Program Files (x86)\SCE\Prospero SDKs\9.000'
-    SHADER_COMPILER_PATH: '${SCE_PROSPERO_SDK_DIR}\target\bins'
+# PS5 related --> win10-ps5:v4 ships SDK 13.000 but defaults SCE_PROSPERO_SDK_DIR to an unsupported version, so set it explicitly.
+    SCE_PROSPERO_SDK_DIR: 'C:\Program Files (x86)\SCE\Prospero SDKs\13.000'
+    SHADER_COMPILER_PATH: '${SCE_PROSPERO_SDK_DIR}\host_tools\bin'
     SCE_ROOT_DIR: 'C:\Program Files (x86)\SCE'
-# Switch related
-    NINTENDO_SDK_ROOT: 'C:\Nintendo\nx_sdk-18_3_0\NintendoSDK'
+# Switch related --> Switch is DISABLED in project.metafile (MTT-15636): 6000.x/trunk editors mandate NintendoSDK 22.2.x, which is not installed on win10-switch:v4 (only nintendosdk-en-21_4_0 is). This target path is correct for when PETS ships 22.2.x and Switch is re-enabled.
+    NINTENDO_SDK_ROOT: 'C:\Nintendo\nintendosdk-en-22_2_0\NintendoSDK'
     UNITY_NINTENDOSDK_CLI_TOOLS: '${NINTENDO_SDK_ROOT}\Tools\CommandLineTools'
   artifacts:
     logs:

.yamato/project-standards.yml

@@ -30,7 +30,7 @@
 
 {% for project in projects.all -%}
 {% for platform in test_platforms.default -%}
-{% for editor in validation_editors.default -%}
+{% for editor in validation_editors.standards -%}
 standards_{{ platform.name }}_{{ project.name }}_{{ editor }}:
   name: Standards Check - NGO {{ project.name }} [{{ platform.name }}, {{ editor }}]
   agent:
@@ -48,8 +48,7 @@ standards_{{ platform.name }}_{{ project.name }}_{{ editor }}:
     - unity-downloader-cli --fast --wait -u {{ editor }} -c editor {% if platform.name == "mac" %} --arch arm64 {% endif %} # For macOS we use ARM64 models. Downloads basic editor
     - .Editor/Unity -batchmode -nographics -logFile - -executeMethod Packages.Rider.Editor.RiderScriptEditor.SyncSolution -projectPath {{ project.path }} -quit # This command is used to invoke Unity in a "headless" mode. It's used to sync the project
     - dotnet run --project=dotnet-tools/netcode.standards -- --project={{ project.path }} --fix # Auto-fix formatting issues
-    - git checkout -- {{ project.path }}/Packages/manifest.json {{ project.path }}/Packages/packages-lock.json {{ project.path }}/ProjectSettings/ProjectVersion.txt 2>/dev/null || true # Restore files that Unity may have modified (we only want to check code formatting)
-    - 'git diff --exit-code || (echo "ERROR: Code formatting issues found. Run dotnet run --project=dotnet-tools/netcode.standards -- --project={{ project.path }} --fix locally and commit the changes." && exit 1)' # Fail if formatter made any changes
+    - 'git diff --exit-code || (echo "ERROR: Code formatting issues found. Run dotnet run --project=dotnet-tools/netcode.standards -- --project={{ project.path }} --fix locally and commit the changes. Note that dotnet version that was used in this check depends on the image that was used so local results may differ (see the first command of this job to know which dotnet version was used)" && exit 1)' # Fail if formatter made any changes
 {% endfor -%}
 {% endfor -%}
 {% endfor -%}

.yamato/project.metafile

@@ -111,18 +111,15 @@ test_platforms:
           flavor: b1.large
           larger_flavor: b1.xlarge
           standalone: PS4
-        # - name: ps5 --> SEE MTT-12118
-        #  type: Unity::VM
-        #  image: package-ci/win10-ps5:v4
-        #  flavor: b1.large
-        #  larger_flavor: b1.xlarge
-        #  standalone: PS5
-        # - name: switch --> TEMPORARILY DISABLED. SEE MTT-12118
-        #   The NintendoSDK on the win10-switch:v4 Bokken image is incomplete for the SDK
-        #   version the newer editor Playback Engines require: 18_3_0 is missing the
-        #   nintendo-switch-support lib the new toolchain links against, and 21_4_3 is missing the
-        #   Tools\Graphics\NvnTools (GraphicsConverter) libraries needed to package textures.
-        #   Neither is fixable from .yamato; re-enable once Package CI ships a complete SDK on the image.
+        # ps5: win10-ps5:v4 defaults SCE_PROSPERO_SDK_DIR to an unsupported SDK, so it is overridden to 13.000 in console-standalone-test.yml.
+        - name: ps5
+          type: Unity::VM
+          image: package-ci/win10-ps5:v4
+          flavor: b1.large
+          larger_flavor: b1.xlarge
+          standalone: PS5
+        # switch --> DISABLED. SEE MTT-15636 (split from MTT-12118). 6000.x/trunk editors mandate NintendoSDK 22.2.x, but package-ci/win10-switch:v4 currently ships only nintendosdk-en-21_4_0. That fixes texture packaging but the native IL2CPP link then fails (undefined symbol std::__1::__hash_memory, from the 22_02 SwitchPlayer.a). Re-enable once PETS publishes a win10-switch image with nintendosdk-en-22_2_x.
+        # - name: switch
         #   type: Unity::VM
         #   image: package-ci/win10-switch:v4
         #   flavor: b1.large
@@ -147,13 +144,14 @@ test_platforms:
           flavor: b1.large
           larger_flavor: b1.xlarge
           standalone: PS4
-        #- name: ps5 --> SEE MTT-12118
-        #  type:  Unity::console::ps5
-        #  image: package-ci/win10-ps5:v4
-        #  flavor: b1.large
-        #  larger_flavor: b1.xlarge
-        #  standalone: PS5
-        # - name: switch --> TEMPORARILY DISABLED. SEE MTT-12118 (incomplete NintendoSDK on win10-switch:v4 image)
+        - name: ps5
+          type: Unity::console::ps5
+          image: package-ci/win10-ps5:v4
+          flavor: b1.large
+          larger_flavor: b1.xlarge
+          standalone: PS5
+        # switch --> DISABLED. SEE MTT-15636 (needs NintendoSDK 22.2.x on the image; see console_build note).
+        # - name: switch
         #   type: Unity::console::switch
         #   image: package-ci/win10-switch:v4
         #   flavor: b1.large
@@ -176,6 +174,7 @@ test_platforms:
 # EDITOR CONFIGURATIONS-------------------------------------------------------------------------------
 # Editors to be used for testing. NGOv2.X official support started from 6000.0 editor
 # TODO: When a new editor will be released it should be added to this list
+# standards editor is used for standards check so we won't get random manifest changes due to newer editor being used
 
 validation_editors:
     default:
@@ -189,6 +188,8 @@ validation_editors:
         - 5fe7931aab8c4fff9274e15ef0800125c68b8d6a
     minimal:
         - 6000.0
+    standards:
+        - 6000.0.72f1
 pinnedTrunk:  5fe7931aab8c4fff9274e15ef0800125c68b8d6a