Merge branch 'develop' into chore/1.x/remove_feature_requests

Author: michalChrobot

.github/pull_request_template.md

@@ -4,14 +4,14 @@ Replace this block with what this PR does and why. Describe what you'd like revi
 )
 
 ### Jira ticket
-_Link to related jira ticket ([Use the smart commits](https://support.atlassian.com/bitbucket-cloud/docs/use-smart-commits/))_
+_Link to related jira ticket ([Use the smart commits](https://support.atlassian.com/bitbucket-cloud/docs/use-smart-commits/)). Short version (e.g. MTT-123) also works and gets auto-linked_
 
 ### Changelog
 [//]: # (updated with all public facing changes  - API changes, UI/UX changes, behaviour changes, bug fixes. Remove if not relevant.)
 
 - Added: The package whose Changelog should be added to should be in the header. Delete the changelog section entirely if it's not needed.
 - Fixed: If you update multiple packages, create a new section with a new header for the other package.
-- Removed/Deprecated/Changed: Each bullet should be prefixed with Added, Fixed, Removed, Deprecated, or Changed to indicate where the entry should go
+- Removed/Deprecated/Changed: Each bullet should be prefixed with Added, Fixed, Removed, Deprecated, or Changed to indicate where the entry should go.
 
 <!--  Uncomment and mark items off with a * if this PR deprecates any API:
 ### Deprecated API
@@ -31,12 +31,14 @@ We should always evaluate if the changes in this PR require any documentation ch
 - Includes documentation for previously-undocumented public API entry points.
 - Includes edits to existing public API documentation.
 
-## Testing & QA
+## Testing & QA (How your changes can be verified during release Playtest)
 [//]: #  (
 This section is REQUIRED and should describe how the changes were tested and how should they be tested when Playtesting for the release.
 It can range from "edge case covered by unit tests" to "manual testing required and new sample was added".
 Expectation is that PR creator does some manual testing and provides a summary of it here.)
 
+<!-- Add any performance testing results here if relevant. -->
+
 ### Functional Testing
 [//]: # (If checked, List manual tests that have been performed.)
 _Manual testing :_
@@ -50,12 +52,13 @@ _Does the change require QA team to:_
 
 - [ ] `Review automated tests`?
 - [ ] `Execute manual tests`?
+- [ ] `Provide feedback about the PR`?
 
-If any boxes above are checked, please add QA as a PR reviewer.
+If any boxes above are checked the QA team will be automatically added as a PR reviewer.
 
-## Backport
+## Backports
 [//]: # (
 This section is REQUIRED and should link to the PR that targets other NGO version which is either develop or develop-2.0.0 branch
 Add the following to the PR title: "\[Backport\] ..."
 If this is not needed, for example feature specific to NGOv2.X, then just mention this fact.
-)
+)

.github/workflows/mark-stale-issue.yaml

@@ -18,7 +18,7 @@ jobs:
       issues: write
 
     steps:
-      - uses: actions/stale@v9
+      - uses: actions/stale@v10
         with:
           # Only mark issues (not PRs) as stale
           any-of-labels: 'stat:awaiting-response'

.github/workflows/pr-verification.yml …/workflows/pr-description-validation.yml.github/workflows/pr-verification.yml renamed to .github/workflows/pr-description-validation.yml .github/workflows/pr-verification.yml renamed to .github/workflows/pr-description-validation.yml

@@ -1,12 +1,12 @@
-# This workflow is designed to verify that the pull request description contains a required sections that are important from quality perspective.
+# This workflow is designed to verify that the pull request description contains a required sections that are important from quality perspective.
 # ## Backport section is important as a reminder to account for backports for anyone that works with NGO repository (to 1.X or 2.X branches respectively).
 # ## Testing & QA section is important to ensure that the PR has appropriate testing coverage and is important when QA will evaluate PRs before Playtesting for the release.
 # ## Documentation section is important to ensure that the documentation is updated with the changes made in the PR.
 
 # If any of the sections is missing, the workflow will fail and block the PR from merging, prompting the developer to add those sections to the PR description.
 # The workflow is configured to run when PR is created as well as when it is edited which also counts simple description edits.
 
-name: "NGO - PR Verification"
+name: "NGO - PR description validation"
 
 on:
   pull_request:
@@ -17,24 +17,39 @@ on:
       - release/*
 
 jobs:
-  pr-verification:
+  pr-description-validation:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       - name: Check PR description
-        uses: actions/github-script@v7
+        uses: actions/github-script@v8
         with:
           script: |
             const pr = context.payload.pull_request;
             const body = pr.body || '';
+            
+            // List of users to skip description validation
+            // This should be automations where we don't care that much about the description format
+            const skipUsersPrefixes = [
+              'unity-renovate',
+              'svc-'
+            ];
+            
+            // If PR author is in the skip list, exit early
+            const author = pr.user.login;
+            console.log(`PR author: ${author}`);
+            if (skipUsersPrefixes.some(prefix => author.startsWith(prefix))) {
+              console.log(`Skipping PR description check for user: ${author}`);
+              return;
+            }
 
             // List of mandatory PR sections
             const requiredSections = [
               {
-                header: '## Backport',
-                description: 'PR description must include a "## Backport" section. Please add this section and provide information about this PR backport to develop or develop-2.0.0 branch respectively or explain why backport is not needed.'
+                header: '## Backports',
+                description: 'PR description must include a "## Backports" section. Please add this section and provide information about this PR backport to develop or develop-2.0.0 branch respectively or explain why backport is not needed.'
               },
               {
                 header: '## Testing & QA',
@@ -43,6 +58,10 @@ jobs:
               {
                 header: '## Documentation',
                 description: 'PR description must include a "## Documentation" section. Please add this section and provide information about the documentation changes made in this PR. It is important to keep the documentation up to date with the code changes.'
+              },
+              {
+                header: '## Jira ticket',
+                description: 'PR description must include a "## Jira ticket" section. Please add this section and provide a link to the Jira ticket that corresponds to this PR. General rule should be that if the PR takes you more then a day of work it should have Jira ticket. Otherwise you can always write "N/A" in this section.'
               }
             ];
 
@@ -59,4 +78,4 @@ jobs:
               message += '\n\nPlease add them to your PR description.';
 
               core.setFailed(message);
-            }
+            }

.github/workflows/pr-supervisor.yaml

@@ -0,0 +1,66 @@
+# GitHub Actions workflow to monitor Yamato CI job state on pull requests
+# We are using https://cli.github.com/manual/gh_pr_checks
+# The aim is to ensure that conditionally triggered Yamato jobs are completed successfully before allowing merges
+
+# This job will be required in branch protection rules for develop, develop-2.0.0, and release/* branches. It's only goal will be to ensure that Yamato jobs are completed successfully before allowing Pr to merge.
+# Note that conditional jobs will have 30s to show which is always the cas since they are showing up as soon as in distribution stage.
+
+name: Yamato PR Supervisor
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+    branches:
+      - develop
+      - develop-2.0.0
+      - release/*
+        
+concurrency:
+  group: pr-${{ github.event.pull_request.number }}
+  cancel-in-progress: true
+
+jobs:
+  yamato-supervisor:
+    runs-on: ubuntu-latest
+    timeout-minutes: 720
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+        
+      - name: Wait and Verify Yamato Job Status
+        env:
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+          PR_NUMBER: ${{ github.event.pull_request.number }}
+        run: |
+          set -e
+          
+          
+          MAX_ATTEMPTS=$((12*60))
+          INTERVAL=60
+          
+          sleep $INTERVAL
+          for ((i=1;i<=MAX_ATTEMPTS;i++)); do
+            echo "Polling PR checks (attempt $i/$MAX_ATTEMPTS)..."
+          
+            # We want to watch for pending checks beside this check
+            checks=$(gh pr checks $PR_NUMBER --json name,state --jq '[ .[] | select(.name != "yamato-supervisor") ]')
+            
+            pending=$(echo "$checks" | jq '[.[] | select(.state == "PENDING")] | length')
+            skipping=$(echo "$checks" | jq '[.[] | select(.state == "SKIPPED")] | length')
+            passed=$(echo "$checks" | jq '[.[] | select(.state == "SUCCESS")] | length')
+            failed=$(echo "$checks" | jq '[.[] | select(.state == "FAILURE")] | length')
+          
+            echo "Pending checks: $pending, Skipping checks: $skipping", Passed checks: $passed, Failed checks: $failed
+          
+            if [[ "$failed" -gt 0 ]]; then
+              echo "A check has failed! Failing fast."
+              exit 1
+            fi
+
+            if [[ "$pending" -eq 0 ]] && [[ "$passed" -gt 0 ]]; then
+              echo "All non-supervisor checks are completed!"
+              exit 0
+            fi
+          
+            sleep $INTERVAL
+          done

.github/workflows/qa-reviewer-assignment.yml

@@ -0,0 +1,36 @@
+# This workflow depend on the content of .github/pull_request_template.md file, which should contain the required sections that the script checks for
+# This also works in parallel with .github/workflows/pr-description-validation.yml which validates PR format
+# In contrast to .github/workflows/pr-description-validation.yml, this workflow is conditional and aims to ease the process of requesting QA review by automatically assigning the QA team  whenever a checkbox is marked
+
+# In case that the given checkboxes are marked the script will automatically add netcode-qa team as a reviewer.
+
+name: 'Assign QA Reviewer'
+
+on:
+  pull_request:
+    types: [opened, edited, synchronize, reopened]
+
+jobs:
+  assign-qa:
+    # This job only runs if the checkbox in the PR description exist and is checked.
+    if: >
+      contains(github.event.pull_request.body, '- [x] `Review automated tests`') ||
+      contains(github.event.pull_request.body, '- [x] `Execute manual tests`') ||
+      contains(github.event.pull_request.body, '- [x] `Provide feedback about the PR`')
+    runs-on: ubuntu-latest
+
+
+    steps:
+
+      - name: 'Assign QA Team'
+        uses: actions/github-script@v8
+        with:
+          github-token: ${{ secrets.GH_TOKEN }}
+          script: |
+            github.rest.pulls.requestReviewers({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              pull_number: context.issue.number,
+              team_reviewers: ['netcode-qa']
+            });
+            console.log('Assigned netcode-qa for review.');

.pr_agent.toml

@@ -0,0 +1,2 @@
+[github_app]
+pr_commands = []

.yamato/README.md

@@ -9,7 +9,6 @@ CI related files are present inside .yamato/ folder and we can distinguish speci
 
 ### Helper jobs
 - `.yamato/package-pack.yml` responsible for generating package artifacts (.tgz) required for testing and publishing.
-- `.yamato/project-pack.yml` responsible for generating package artifacts (.tgz) required for testing and publishing. This packs all packages of a given project.
 - `.yamato/_run-all.yml` responsible for grouping tests into groups for easier management (for example "all console tests").
 - `.yamato/_triggers.yml` responsible for defining triggers (PR, nightly, weekly etc.) and defining which tests to run.
 - `disable-burst-if-requested.py` responsible for helping to disable burst if needed.
@@ -70,11 +69,11 @@ Currently, the CI implementation supports the following platforms:
     - Ubuntu
     - macOS
 4. Unity Editor Versions
-    - Supports NGOv1.X (2021.3+ editors)
+    - Supports NGOv1.X (2022.3+ editors)
 5. Architectures
     - x64
     - ARM64 (This is present for consoles/mobiles but will be extended. More information is present in specific standalone test files)
 
 ## Design Considerations
 In theory, we could manually write jobs for every configuration. However, this approach would be more error-prone, especially when modifications or fixes are needed, as it would require keeping track of all configurations.
-The downside of our current approach is that it can sometimes impact readability due to the use of nested if and for statements.
+The downside of our current approach is that it can sometimes impact readability due to the use of nested if and for statements.