Skip to content

Commit 341cf66

Browse files
style
Clearing out some of the verbosity.
1 parent a08449b commit 341cf66

5 files changed

Lines changed: 8 additions & 43 deletions

File tree

.yamato/_run-all.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -447,7 +447,6 @@ run_all_project_tests_cmb_service_default:
447447

448448

449449
# Runs the NGO 2.x -> 3.x editor script upgrade validation (see api-updater-test.yml)
450-
# Manual only today. Add this to develop_nightly or develop_weekly_trunk in _triggers.yml to schedule it.
451450
run_all_api_updater_tests:
452451
name: Run All API Updater Tests
453452
dependencies:

.yamato/_triggers.yml

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -116,11 +116,6 @@ pr_code_changes_checks:
116116
cancel_old_ci: true
117117

118118

119-
120-
121-
122-
123-
124119
# Unified (NGO + N4E) validation, on demand.
125120
# This job allows the Unified tests to be kicked off by commenting "/ci unified".
126121
# This is useful for PRs where pr_code_changes_checks doesn't trigger.
@@ -134,12 +129,8 @@ unified_pr_checks:
134129
cancel_old_ci: true
135130

136131

137-
# NGO 2.x -> 3.x editor script upgrade validation, on demand.
132+
# NGO 2.x -> 3.x on demand editor script upgrade validation.
138133
# This job allows the API updater test to be kicked off by commenting "/ci apiupdater".
139-
# It is deliberately not part of the PR gate: what it protects only changes when a public editor type
140-
# is added, moved or removed, so paying a full editor import on every PR is not worth it.
141-
# To put it on a schedule, add .yamato/_run-all.yml#run_all_api_updater_tests to develop_nightly or
142-
# develop_weekly_trunk below.
143134
api_updater_pr_checks:
144135
name: API Updater checks [on demand]
145136
dependencies:

.yamato/api-updater-test.yml

Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{% metadata_file .yamato/project.metafile %} # All configuration that is used to create different configurations (used in for loops) is taken from this file.
1+
{% metadata_file .yamato/project.metafile %}
22
---
33

44
# DESCRIPTION--------------------------------------------------------------------------
@@ -10,20 +10,6 @@
1010
# -accept-apiupdate and asserts that every 2.x type reference was rewritten and none survived.
1111
# See apiupdaterproject/README.md.
1212

13-
# WHY THIS JOB IS MANUAL ONLY-----------------------------------------------------------
14-
# It is deliberately not wired into pr_minimal_required_checks or pr_code_changes_checks. The thing
15-
# it protects only changes when a public editor type is added, moved or removed, so paying a full
16-
# editor import on every PR is not worth it. Kick it off with "/ci apiupdater" in a PR comment
17-
# (see api_updater_pr_checks in _triggers.yml), or from the Yamato UI.
18-
# If it should also run on a schedule, add .yamato/_run-all.yml#run_all_api_updater_tests to
19-
# develop_nightly or develop_weekly_trunk in _triggers.yml.
20-
21-
# CONFIGURATION STRUCTURE--------------------------------------------------------------
22-
# Runs on the default platform (Ubuntu) like every other basic job. run_upgrade_test.py is Python, so
23-
# there is no platform constraint - the earlier PowerShell version forced a Windows agent because it
24-
# needed robocopy to purge Library past MAX_PATH.
25-
# A single editor is enough - the job is asserting on the editor's API updater, not on NGO
26-
# behaviour across editor versions. Widen to validation_editors.all if that stops being true.
2713

2814
# TECHNICAL CONSIDERATIONS---------------------------------------------------------------
2915
# apiupdaterproject/Packages/manifest.json references the package by relative path
@@ -34,15 +20,6 @@
3420
# --clean purges Library first: the assertion is meaningless against a warm Library that already
3521
# holds rewritten sources from a previous run.
3622

37-
# QUALITY CONSIDERATIONS--------------------------------------------------------------------
38-
# The expected type list in run_upgrade_test.py is inline and hand-written. That is fine because
39-
# its input is frozen: it enumerates the 2.x public editor API, and develop-2.0.0 is released.
40-
# TODO: the list does not extend itself. A later relocation within 3.x, or a back port into 2.x,
41-
# has to be added by hand or this job silently stops covering it. Deriving the list from the
42-
# [MovedFrom] attributes in the package source would close that.
43-
44-
#------------------------------------------------------------------------------------
45-
4623
{% for platform in test_platforms.default -%}
4724
{% for editor in validation_editors.default -%}
4825
api_updater_test_{{ platform.name }}_{{ editor }}:

apiupdaterproject/Assets/Editor/DeprecatedApiUsage.cs

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
// NGO 2.x-era editor code. Every type reference below must be rewritten by Unity's API updater to
2-
// its `Unity.Netcode.GameObjects.Editor` equivalent. Do not "fix" this file - it is the input to
3-
// the upgrade test. See ../../README.md.
4-
#pragma warning disable 169 // field is never used
1+
// Update only if new public editor API is added to NGO v2.x.x.
2+
// It is used to validate the upgrade test. See ../../README.md.
3+
#pragma warning disable 169 // Ignore field is never used warnings
54

65
using ApiUpdaterProject;
76
using Unity.Netcode.Editor;

apiupdaterproject/Assets/Editor/DeprecatedApiUsageQualified.cs

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
// The same 2.x API reached through the reference forms the updater has to handle separately from a
2-
// plain `using` + simple name: fully qualified names, a namespace alias, a type alias, a base type
3-
// and a typeof. Do not "fix" this file - it is the input to the upgrade test.
4-
#pragma warning disable 169 // field is never used
1+
// Update only if new public editor API is added to NGO v2.x.x.
2+
// It is used to validate the upgrade test. See ../../README.md.
3+
#pragma warning disable 169 // Ignore field is never used warnings
54

65
using System;
76
using Cfg = Unity.Netcode.Editor.Configuration;

0 commit comments

Comments
 (0)