project-pack comments

Author: michalChrobot

.yamato/project-pack.yml

@@ -1,9 +1,26 @@
-{% 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.
 ---
 
-# Jobs that iterate through and packs all NGO projects listed (to use in different jobs)
-# For this job no specific platform support and no running Unity instance is required so small agent (as per project.metafile definition) coul be used to save resources and speed up the process
-# If everyone adheres to this rule it can create bottlenecks (since everyone would use this machine) so we decided to pack project with the same platform as the given job runs on
+# DESCRIPTION--------------------------------------------------------------------------
+  # This job is responsible for packing a specific project. It generates package artifacts (.tgz) required for testing and publishing, ensuring all dependencies are properly bundled and validated before any test execution.
+  # The job itself doesn't test anything specific but rather it prepares project packages that will be consumed by other pipeline jobs.
+  
+# CONFIGURATION STRUCTURE--------------------------------------------------------------
+  # Jobs configurations are generated using nested loops through:
+    # 1. For all projects (testproject, minimalproject, testproject-tools-integration).
+    # 2. For all desktop platforms (Win, Ubuntu, Mac)
+  
+# TECHNICAL CONSIDERATIONS--------------------------------------------------------------------
+  # Job does not require Unity Editor in order to perform packing.
+  # In theory, we could just use one platform for packing projects (for example ubuntu) but in order to reduce confusion we are using same platform as the job utilizing project pack as dependency.
+  
+# QUALITY CONSIDERATIONS--------------------------------------------------------------------
+  # To see where this job is included (in trigger job definitions) look into _triggers.yml file
+  # TODO: Currently upm-ci is being used but in the future it will be replaced by upm-pvp. Additionally this would allow us to run PVP checks on projects
+  
+  
+#-------------------------------------------------------------------------------------- 
+  
 {% for project in projects.all -%}
 {% for platform in test_platforms.desktop -%}
 project_pack_-_{{ project.name }}_{{ platform.name }}:
@@ -13,7 +30,7 @@ project_pack_-_{{ project.name }}_{{ platform.name }}:
     image: {{ platform.image }}
     flavor: {{ platform.flavor }}
   commands:
-    - npm install -g upm-ci-utils@stable --registry https://artifactory.prd.cds.internal.unity3d.com/artifactory/api/npm/upm-npm
+    - npm install upm-ci-utils@stable -g --registry https://artifactory.prd.cds.internal.unity3d.com/artifactory/api/npm/upm-npm # upm-ci is not preinstalled on the image so we need to download it
     - upm-ci project pack --project-path {{ project.path }}
   artifacts:
     packages: