Skip to content

chore: Added upgrade-guide for 2.X --> 3.X migration - #4153

Open
michalChrobot wants to merge 3 commits into
develop-3.x.xfrom
migration-guide
Open

chore: Added upgrade-guide for 2.X --> 3.X migration#4153
michalChrobot wants to merge 3 commits into
develop-3.x.xfrom
migration-guide

Conversation

@michalChrobot

Copy link
Copy Markdown
Member

Purpose of this PR

Adding upgrade-guide in the same way as it was added for N4E. Feel free to make any corrections to it

Jira ticket

N/A

Documentation

Added migration-guide doc

Testing & QA (How your changes can be verified during release Playtest)

N/A

Up-port

N/A

Backports

N/A

@u-pr u-pr Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Harness Review

Needs changes

The new guide accurately reflects most source-level breaking changes, but it contains several contradictory upgrade instructions.

Reviewed commit 9949c55

🤖 Helpful? 👍/👎

Comment thread com.unity.netcode.gameobjects/Documentation~/upgrade-guide.md Outdated
Comment thread com.unity.netcode.gameobjects/Documentation~/upgrade-guide.md Outdated
Comment thread com.unity.netcode.gameobjects/Documentation~/upgrade-guide.md Outdated
@michalChrobot

Copy link
Copy Markdown
Member Author

we can land this after 3.X release

@u-pr

u-pr Bot commented Sep 10, 2026

Copy link
Copy Markdown

⚠️ Some settings were ignored in '.pr_agent.toml (repository root)' repo settings

Check the configuration's TOML syntax, permitted settings, and size limit. See the error below.


Error message:
Ignored prohibited settings: github_app.handle_pr_actions. Permitted settings were applied.

Configuration content:
# This is the configuration for the u-pr bot
# https://github.cds.internal.unity3d.com/unity/u-pr
# For configuration of this file:
# https://developer.portal.internal.unity.com/catalog/default/component/u-pr/docs/configuration/automatic_runs/

[github_app]
handle_pr_actions = ['opened', 'ready_for_review']  # PR events that auto-run pr_commands
pr_commands       = ["/harness-review"]             # what runs on those events
reviewer_commands = ["/harness-review"]             # what runs when @u-pr is added as reviewer

@jabbacakes

Copy link
Copy Markdown
Contributor

/review

@u-pr u-pr Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Harness Review

Needs changes

The migration guide is generally aligned with the current API and behavior changes, but one documented replacement does not provide a valid migration for the normal legacy call pattern.

Reviewed commit 2393dcc

🤖 Helpful? 👍/👎

Comment thread com.unity.netcode.gameobjects/Documentation~/upgrade-guide.md Outdated

@jabbacakes jabbacakes left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Committed directly with changes that bring this upgrade guide in line with the Netcode for Entities one, as well as general style/wording/thoroughness updates.

Ready for review by @NoelStephensUnity and/or @EmandM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants