Skip to content

Commit e5ec505

Browse files
committed
more comments
1 parent d6f5b2e commit e5ec505

File tree

2 files changed

+13
-6
lines changed

2 files changed

+13
-6
lines changed

.github/workflows/pr-supervisor.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
# We are using https://cli.github.com/manual/gh_pr_checks
33
# The aim is to ensure that conditionally triggered Yamato jobs are completed successfully before allowing merges
44

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+
58
name: Yamato PR Supervisor
69

710
on:

.yamato/_triggers.yml

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,23 @@
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

1315
# Pull Request:
14-
# This test validates Standards, Package tests, Project tests and Desktop standalone tests to ensure that main platforms are covered
15-
# Focuses on critical validation paths that we should validate before merging PRs. It also cancels previous runs on new commits
16-
# By default it's triggered if
16+
# We have two PR triggers:
17+
# 1) Minimal PR checks that run on all PRs (even if only docs are changed)
18+
# 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
19+
# By default pr_minimal_required_checks it's triggered if
1720
# 1) PR targets develop, develop-2.0.0 or release branches
1821
# 2) PR is not a draft
19-
# 3) PR changes files in package or testproject folders (doesn't run on for example DOCS only changes)
22+
# Then pr_code_changes_checks it's triggered if the same conditions apply plus:
23+
# 1) PR changes code in com.unity.netcode.gameobjects package (Editor, Runtime or Tests folders) or in testproject folder or package.json file
2024

2125
# Note that in other cases you can trigger it by writing a comment "/ci ngo" in the PR thread
2226

@@ -44,7 +48,7 @@
4448

4549
# 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
4650
# This trigger was created to ensure that ALL PRs run this minimal check even when we don't need to run full tests
47-
minimal_required_checks:
51+
pr_minimal_required_checks:
4852
name: Minimal PR checks
4953
dependencies:
5054
- .yamato/package-pack.yml#package_pack_-_ngo_win
@@ -64,7 +68,7 @@ minimal_required_checks:
6468
# 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.
6569
# This optimization allows to speed up feedback look for any "obvious" errors and save resources.
6670
# Since standards job is a part of initial checks it's not present as direct dependency here!!!!!!!!!!!!!!!!!!!!
67-
code_changes_checks:
71+
pr_code_changes_checks:
6872
name: Code changes PR checks
6973
# Run the following tests on a selection of different desktop platforms
7074
dependencies:

0 commit comments

Comments
 (0)