Added package-pack comments and modifications

Author: michalChrobot

.yamato/package-tests.yml

@@ -1,9 +1,29 @@
-{% metadata_file .yamato/project.metafile %}
+{% metadata_file .yamato/project.metafile %} # All configuration that is used to create different configurations (used in for loops) is taken from this file.
 ---
 
-# Executes PlayMode and EditMode tests of the NGO package in the Editor context
-# Those tests run in the editor so we don't need to consider different scripting backends or architectures
-# Tests are executed for all supported editors on each desktop platform as in project.metafile declaration
+# DESCRIPTION--------------------------------------------------------------------------
+  # This job is responsible for execution of package-specific tests in Unity Editor context
+  # Those tests cover both PlayMode and EditMode tests from package test assemblies
+  # Additionally it combines Package Verification Pipeline (PVP) validation. This ensures that package is compatible with Unity standards
+  
+# CONFIGURATION STRUCTURE--------------------------------------------------------------
+  # Jobs are generated using nested loops through:
+    # 1. For all desktop platforms (Windows, Ubuntu, macOS)
+    # 2. For all supported Unity Editor versions (for NGOv1.X this means 2021.3+ editors)
+  
+# TECHNICAL CONSIDERATIONS---------------------------------------------------------------
+  # This job runs in Editor context only (no player builds required)
+  # No scripting backend variations needed (Editor context)
+  # Architecture variations not applicable (Editor context)
+  # Requires project packaging as prerequisite (dependency job)
+  # Uses PVP for package validation. Specifically it looks for supported profiles which we should conform to but takes ./pvpExceptions.json file into consideration where we note our known issues related to PVP checks
+  
+# QUALITY CONSIDERATIONS--------------------------------------------------------------------
+  # To see where this job is included (in trigger job definitions) look into _triggers.yml file
+  # TODO: we should aim to replace target PVP profile from supported to gold
+  
+#------------------------------------------------------------------------------------
+  
 {% for platform in test_platforms.desktop -%}
 {% for editor in validation_editors.all -%}
 package_test_-_ngo_{{ editor }}_{{ platform.name }}:
@@ -17,13 +37,14 @@ package_test_-_ngo_{{ editor }}_{{ platform.name }}:
     UNITY_EXT_LOGGING: 1
   commands:
     - unity-downloader-cli -u {{ editor }} -c Editor --fast --wait
-  
-    # Validate packages.
+    
+    # Validate PVP checks for package.
     - upm-pvp test --unity .Editor --packages "upm-ci~/packages/*.tgz" --filter "com.unity.netcode.gameobjects" --results pvp-results
     - upm-pvp require {% if platform.name == "win" %}"%XRAY_PROFILE%"{% else %}"$XRAY_PROFILE"{% endif %} --results pvp-results
+
     # Run UTR to test packages.
     - upm-pvp create-test-project test-project --packages "upm-ci~/packages/*.tgz" --filter "com.unity.netcode.gameobjects" --unity .Editor
-    - {% if platform.name == "ubuntu" %}DISPLAY=:0 {% endif %} UnifiedTestRunner --suite=editor --suite=playmode --editor-location=.Editor --testproject=test-project --artifacts-path=test-results "--ff={ops.upmpvpevidence.enable=true}" --extra-editor-arg=-testCategory --extra-editor-arg=!Performance --reruncount=1 --clean-library-on-rerun
+    - UnifiedTestRunner --suite=editor --suite=playmode --editor-location=.Editor --testproject=test-project --artifacts-path=test-results "--ff={ops.upmpvpevidence.enable=true}" --reruncount=1 --clean-library-on-rerun
   artifacts:
     logs:
       paths: