Skip to content

Commit c81bd19

Browse files
michalChrobotmichalChrobot
authored
ci: [Backport] Adding minimal required job set and validation preventing PRs from merging when tests are running (#3691)
## Purpose of this PR This is a backport of #3682. Same description apply ### Jira ticket N/A ## Documentation Same as original PR ## Testing & QA (How your changes can be verified during release Playtest) Same as original PR ## Backports This is a backport of #3682
1 parent 1eca4b3 commit c81bd19

File tree

2 files changed

+117
-18
lines changed

2 files changed

+117
-18
lines changed

‎.github/workflows/pr-supervisor.yaml‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# GitHub Actions workflow to monitor Yamato CI job state on pull requests
2+
# We are using https://cli.github.com/manual/gh_pr_checks
3+
# The aim is to ensure that conditionally triggered Yamato jobs are completed successfully before allowing merges
4+
5+
# 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.
6+
# 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.
7+
8+
name: Yamato PR Supervisor
9+
10+
on:
11+
pull_request:
12+
types: [opened, synchronize, reopened]
13+
branches:
14+
- develop
15+
- develop-2.0.0
16+
- release/*
17+
18+
concurrency:
19+
group: pr-${{ github.event.pull_request.number }}
20+
cancel-in-progress: true
21+
22+
jobs:
23+
yamato-supervisor:
24+
runs-on: ubuntu-latest
25+
timeout-minutes: 720
26+
steps:
27+
- name: Checkout repository
28+
uses: actions/checkout@v4
29+
30+
- name: Wait and Verify Yamato Job Status
31+
env:
32+
GH_TOKEN: ${{ secrets.GH_TOKEN }}
33+
PR_NUMBER: ${{ github.event.pull_request.number }}
34+
run: |
35+
set -e
36+
37+
38+
MAX_ATTEMPTS=$((12*60))
39+
INTERVAL=60
40+
41+
sleep $INTERVAL
42+
for ((i=1;i<=MAX_ATTEMPTS;i++)); do
43+
echo "Polling PR checks (attempt $i/$MAX_ATTEMPTS)..."
44+
45+
# We want to watch for pending checks beside this check
46+
checks=$(gh pr checks $PR_NUMBER --json name,state --jq '[ .[] | select(.name != "yamato-supervisor") ]')
47+
48+
pending=$(echo "$checks" | jq '[.[] | select(.state == "PENDING")] | length')
49+
skipping=$(echo "$checks" | jq '[.[] | select(.state == "SKIPPED")] | length')
50+
passed=$(echo "$checks" | jq '[.[] | select(.state == "SUCCESS")] | length')
51+
failed=$(echo "$checks" | jq '[.[] | select(.state == "FAILURE")] | length')
52+
53+
echo "Pending checks: $pending, Skipping checks: $skipping", Passed checks: $passed, Failed checks: $failed
54+
55+
if [[ "$failed" -gt 0 ]]; then
56+
echo "A check has failed! Failing fast."
57+
exit 1
58+
fi
59+
60+
if [[ "$pending" -eq 0 ]] && [[ "$passed" -gt 0 ]]; then
61+
echo "All non-supervisor checks are completed!"
62+
exit 0
63+
fi
64+
65+
sleep $INTERVAL
66+
done

‎.yamato/_triggers.yml‎

Lines changed: 51 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,22 @@
44
# DESCRIPTION--------------------------------------------------------------------------
55
# This configuration defines three main CI trigger patterns:
66
# 1. Pull Request Validation: Validation performed on PR basis
7+
# - we have mandatory minimal checks that run on all PRs (even if only docs are changed)
8+
# - we have more extensive pr_code_changes_checks that run if code is changed
79
# 2. Nightly Development: Test set run nightly (validates most important test cases)
810
# 3. Weekly Full Validation: Test set run weekly (validates all test cases to prevent any surprises)
911
# Each pattern represents different balance between validation depth, execution time and CI resource usage
1012

1113
# TRIGGER PATTERNS-------------------------------------------------------------------
1214
# Pull Request:
13-
# This test validates Standards, Package tests, Project tests and Desktop standalone tests to ensure that main platforms are covered
14-
# Focuses on critical validation paths that we should validate before merging PRs. It also cancels previous runs on new commits
15-
# By default it's triggered if
15+
# We have two PR triggers:
16+
# 1) Minimal PR checks that run on all PRs (even if only docs are changed)
17+
# 2) More extensive pr_code_changes_checks that run if code is changed. This test validates Standards, Package tests, Project tests and Desktop standalone tests to ensure that main platforms are covered
18+
# By default pr_minimal_required_checks it's triggered if
1619
# 1) PR targets develop, develop-2.0.0 or release branches
1720
# 2) PR is not a draft
18-
# 3) PR changes files in package or testproject folders (doesn't run on for example DOCS only changes)
19-
20-
# Note that in other cases you can trigger it by writing a comment "/ci ngo" in the PR thread
21+
# Then pr_code_changes_checks it's triggered if the same conditions apply plus:
22+
# 1) PR changes code in com.unity.netcode.gameobjects package (Editor, Runtime or Tests folders) or in testproject folder or package.json file
2123

2224
# Nightly:
2325
# This test validates same subset as pull_request_trigger with addition of mobile/console tests and webgl builds
@@ -39,14 +41,32 @@
3941
# It's important to ensure that all dependencies exist (this can be verified in Yamato) since a modification in parameters may result in a given job not being generated, and thus we will not be able to run such erroneous job.
4042

4143

42-
#-----------------------------------------------------------------------------------
44+
#-----------------------------------------------------------------------------------
45+
46+
# After some experimenting with CI setups we discovered that even though sometimes we don't need CI to run (no reason to run package tests if only Documentation is changed) there are some checks that devs may not realize but changes in seemingly unrelated files will cause their failures
47+
# This trigger was created to ensure that ALL PRs run this minimal check even when we don't need to run full tests
48+
pr_minimal_required_checks:
49+
name: Minimal PR checks
50+
dependencies:
51+
- .yamato/package-pack.yml#package_pack_-_ngo_win
52+
- .yamato/project-standards.yml#standards_ubuntu_testproject_6000.2
53+
triggers:
54+
expression: |-
55+
(pull_request.comment eq "ngo" OR
56+
(pull_request.target eq "develop" OR
57+
pull_request.target eq "develop-2.0.0" OR
58+
pull_request.target match "release/*")) AND
59+
NOT pull_request.draft
60+
cancel_old_ci: true
4361

4462

4563
# Run all relevant tasks when a pull request targeting the develop or release branch is created or updated.
4664
# In order to have better coverage we run desktop standalone tests with different configurations which allows to mostly cover for different platforms, scripting backends and editor versions.
47-
# Since standards job is a part of initial checks it's not present as direct dependency here
48-
pull_request_trigger:
49-
name: Pull Request Trigger (develop, develop-2.0.0, & release branches)
65+
# This job will FIRST run "run_quick_checks" jobs (defined in _run-all.yml) since it's the dependency of project pack jobs which is on the lowest dependency tier. This runs the fastest checks (like PVP or code standards) and ONLY IF those pass it will run the rest of the tests.
66+
# This optimization allows to speed up feedback look for any "obvious" errors and save resources.
67+
# Since standards job is a part of initial checks it's not present as direct dependency here!!!!!!!!!!!!!!!!!!!!
68+
pr_code_changes_checks:
69+
name: Code changes PR checks
5070
# Run the following tests on a selection of different desktop platforms
5171
dependencies:
5272
# Run package EditMode and Playmode package tests on 6000.2 (latest supported editor) and an older supported editor (2022.3) (2022.3 will soon be a minimum supported editor)
@@ -65,18 +85,31 @@ pull_request_trigger:
6585
# Coverage on other standalone machines is present in Nightly job so it's enough to not run all of them for PRs
6686
- .yamato/desktop-standalone-tests.yml#desktop_standalone_test_testproject_ubuntu_il2cpp_2022.3
6787
triggers:
68-
# Note that PR tests will run ONLY if we are changing package/sample code. If changes are let's say docs only no tests will be triggered
69-
# TODO: consider setting up and running tests from Examples/
70-
# TODO: or docs only changes are spelling/link check
7188
expression: |-
72-
pull_request.comment eq "ngo" OR
73-
((pull_request.target eq "develop" OR
89+
(pull_request.comment eq "ngo" OR
90+
(pull_request.target eq "develop" OR
7491
pull_request.target eq "develop-2.0.0" OR
75-
pull_request.target match "release/*") AND
92+
pull_request.target match "release/*")) AND
7693
NOT pull_request.draft AND
77-
(pull_request.changes.any match "com.unity.netcode.gameobjects/**" OR
78-
pull_request.changes.any match "testproject/**"))
94+
pull_request.changes.any match [
95+
"com.unity.netcode.gameobjects/Editor/**",
96+
"com.unity.netcode.gameobjects/Runtime/**",
97+
"com.unity.netcode.gameobjects/Tests/**",
98+
"testproject/**",
99+
"com.unity.netcode.gameobjects/package.json"
100+
] AND
101+
NOT pull_request.changes.all match [
102+
"**/Documentation~/**",
103+
"**/InternalDocs~/**",
104+
"**/*.md"
105+
]
79106
cancel_old_ci: true
107+
108+
109+
110+
111+
112+
80113

81114
# Run all tests on 6000.2 (latest supported editor) on nightly basis.
82115
# Same subset as pull_request_trigger with addition of mobile/desktop/console tests and webgl builds

0 commit comments

Comments
 (0)