Support Unity Package Manager #2343

aaronchapin-tocaboca · 2021-10-27T14:14:15Z

What type of PR is this?

Uncomment only one /kind <> line, press enter to put that in a new line, and remove leading whitespace from that line:

/kind breaking
/kind bug
/kind cleanup
/kind documentation

/kind feature

/kind hotfix

What this PR does / Why we need it:
Unity has its own package manager, which can be used to load external dependencies. This change allows unity developers to add the Agones SDK to their project by simply adding a line to their manifest.json file that follows this format:
"com.googleforgames.agones": "https://github.com/googleforgames/agones.git?path=/sdks/unity#<TAG>",
Instead of manually downloading the SDK code locally and placing it in their project's folder structure.

Which issue(s) this PR fixes:
Closes #2338

Special notes for your reviewer:
I took some educated guesses about the desired values for fields like the version number, author name/url etc. Any of these can be changed without an issue - just let me know what is preferred.

Added:

Agones Unity SDK assembly definition file
Package information json
Meta files required by the Unity engine

- Agones assembly definition - Package information - Meta files required for the engine

google-oss-robot · 2021-10-27T14:14:34Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: aaronchapin-tocaboca
To complete the pull request process, please assign pooneh-m after the PR has been reviewed.
You can assign the PR to them by writing /assign @pooneh-m in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

agones-bot · 2021-10-27T14:41:52Z

Build Succeeded 👏

Build Id: f31fb896-b1a0-409e-8c61-0d04609a9f4b

The following development artifacts have been built, and will exist for the next 30 days:

image: gcr.io/agones-images/agones-controller:1.19.0-7873509
image: gcr.io/agones-images/agones-ping:1.19.0-7873509
Linux C++ SDK (build): agonessdk-1.19.0-7873509-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.19.0-7873509.zip

A preview of the website (the last 30 builds are retained):

https://7873509-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/2343/head:pr_2343 && git checkout pr_2343
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.19.0-7873509

markmandel · 2021-10-27T20:57:33Z

sdks/unity/package.json

@@ -0,0 +1,11 @@
+{
+    "name": "com.googleforgames.agones",
+    "version": "1.18.1",


Is this the version of Unity it works with, or is this the version of Agones it corresponds to?

This would be the version of Agones that the package corresponds to.

A complete list of all the properties and their descriptions can be found here: https://docs.unity3d.com/Manual/upm-manifestPkg.html

That page says that the version must be MAJOR.MINOR.PATCH but also says it can follow semantic versioning, which would allow us to have this version match what we use elsewhere, e.g. 1.19.0-dev (then 1.19.0-rc, then 1.19.0, then 1.20.0-dev, and so on).

Do you know if unity will work correctly with our semantic versioning scheme.

I answered this question in another thread, but just to have the info here as well: I tested this semantic versioning scheme and it is supported.

agones-bot · 2021-10-28T10:21:40Z

Build Succeeded 👏

Build Id: 2daae425-5842-4b5b-85b9-9cb16d5f40a8

The following development artifacts have been built, and will exist for the next 30 days:

image: gcr.io/agones-images/agones-controller:1.19.0-64f7b52
image: gcr.io/agones-images/agones-ping:1.19.0-64f7b52
Linux C++ SDK (build): agonessdk-1.19.0-64f7b52-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.19.0-64f7b52.zip

A preview of the website (the last 30 builds are retained):

https://64f7b52-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/2343/head:pr_2343 && git checkout pr_2343
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.19.0-64f7b52

roberthbailey

There are a lot of guid values in these files. Where do they come from? And when do they need to be updated?

If we change the version during the release process, does that require updating any other fields?

roberthbailey · 2021-10-29T07:38:41Z

sdks/unity/package.json

@@ -0,0 +1,11 @@
+{
+    "name": "com.googleforgames.agones",
+    "version": "1.18.1",


That page says that the version must be MAJOR.MINOR.PATCH but also says it can follow semantic versioning, which would allow us to have this version match what we use elsewhere, e.g. 1.19.0-dev (then 1.19.0-rc, then 1.19.0, then 1.20.0-dev, and so on).

Do you know if unity will work correctly with our semantic versioning scheme.

roberthbailey · 2021-10-29T07:39:55Z

sdks/unity/package.json

+    "description": "The Unity Gameserver SDK for Agones",
+    "unity": "2019.1",
+    "author": {
+      "name": "Google For Games",


The NodeJS and csharp SDKs has the author set to "Google LLC"

Regarding semantic versioning - yes it does work. I tried out a -dev append on a separate branch (here) and it functioned as expected. So that shouldn't be a problem.

I wasn't sure what to set the version number to, but I assumed that if this PR is accepted it'll go out with the next release. Do you have a way of updating the version number across the repo that I could utilize here?

Regarding author name, that has been updated.

Please add a new step to the section "Update SDK Package Versions" in https://github.com/googleforgames/agones/blob/main/docs/governance/templates/release_issue.md to bump the version number (we currently have steps for the nodejs and csharp SDKs). You should also add a step near the very end to bump the version after a full release (look for "If full release, change to the sdks/nodejs directory").

Since this will pull from github, it sounds like we don't need to update the "Publish SDK packages" section.

Updated 👍

…apin-tocaboca/agones into feature/issue-2338-unity-package

aaronchapin-tocaboca · 2021-10-29T09:47:43Z

There are a lot of guid values in these files. Where do they come from? And when do they need to be updated?

They are created by the Unity engine on file creation. They don't need to be updated aside from removing the .meta file if the file is removed. In fact, if they are updated it could cause issues.
More information about unity meta files can be found here:
https://docs.unity3d.com/Manual/AssetMetadata.html
https://unityatscale.com/unity-meta-file-guide/faq/

If we change the version during the release process, does that require updating any other fields?

Not as far as I'm aware.

agones-bot · 2021-10-29T10:09:11Z

Build Succeeded 👏

Build Id: 310decd9-3a26-45d2-8c17-e026227400be

The following development artifacts have been built, and will exist for the next 30 days:

image: gcr.io/agones-images/agones-controller:1.19.0-5ac61b9
image: gcr.io/agones-images/agones-ping:1.19.0-5ac61b9
Linux C++ SDK (build): agonessdk-1.19.0-5ac61b9-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.19.0-5ac61b9.zip

A preview of the website (the last 30 builds are retained):

https://5ac61b9-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/2343/head:pr_2343 && git checkout pr_2343
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.19.0-5ac61b9

agones-bot · 2021-10-29T12:12:38Z

Build Failed 😱

Build Id: 8bbc7671-f1da-446e-9538-6572e2f1131f

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

…apin-tocaboca/agones into feature/issue-2338-unity-package

agones-bot · 2021-11-01T15:59:20Z

Build Failed 😱

Build Id: 180406dc-a5ef-4a7b-aa3b-9989b6f47858

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

agones-bot · 2021-11-03T16:14:58Z

Build Succeeded 👏

Build Id: 7158a89a-04f8-4b50-80b2-1a548aa073c3

The following development artifacts have been built, and will exist for the next 30 days:

image: gcr.io/agones-images/agones-controller:1.19.0-34c3440
image: gcr.io/agones-images/agones-ping:1.19.0-34c3440
Linux C++ SDK (build): agonessdk-1.19.0-34c3440-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.19.0-34c3440.zip

A preview of the website (the last 30 builds are retained):

https://34c3440-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/2343/head:pr_2343 && git checkout pr_2343
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.19.0-34c3440

markmandel · 2021-11-04T16:28:06Z

docs/governance/templates/release_issue.md

@@ -80,6 +80,7 @@ and copy it into a release issue. Fill in relevant values, found inside {}
 - [ ] If full release move the [helm `Chart` version values][chart] is to {version}+1-dev
 - [ ] If full release, change to the `sdks/nodejs` directory and run the command `npm version {version}+1-dev` to update the package version
 - [ ] If full release move the [`sdks/csharp/sdk/AgonesSDK.nuspec` and `sdks/csharp/sdk/csharp-sdk.csproj`][csharp] to {version}+1-dev
+- [ ] If full release update the [`sdks/unity/package.json`][unity] package file's `Version` field to {version}+1-dev


We should also add a checklist item in the Update SDK Package Versions section as well to increment the Unity version 👍🏻

…issue-2338-unity-package

…apin-tocaboca/agones into feature/issue-2338-unity-package

agones-bot · 2021-11-08T13:17:04Z

Build Failed 😱

Build Id: 93900d10-2f49-4af3-8b3a-54628bddd2f3

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

markmandel · 2021-11-08T19:36:01Z

Looks like a flake of TestAutoscalerStressCreate

markmandel

This LGTM!

The only thing I just realised was outstanding on my end -

We should update https://agones.dev/site/docs/guides/client-sdks/unity/#download to have the new instructions on the best way to install.

We'll need to use the feature shortcode to hide and show the current vs new content:
https://agones.dev/site/docs/contribute/#within-a-page

agones-bot · 2021-11-08T22:25:54Z

Build Succeeded 👏

Build Id: 387e7f2e-a8ce-47df-9e46-c44f6e6bc632

The following development artifacts have been built, and will exist for the next 30 days:

image: gcr.io/agones-images/agones-controller:1.19.0-3daebb4
image: gcr.io/agones-images/agones-ping:1.19.0-3daebb4
Linux C++ SDK (build): agonessdk-1.19.0-3daebb4-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.19.0-3daebb4.zip

A preview of the website (the last 30 builds are retained):

https://3daebb4-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/2343/head:pr_2343 && git checkout pr_2343
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.19.0-3daebb4

…issue-2338-unity-package

…apin-tocaboca/agones into feature/issue-2338-unity-package

agones-bot · 2021-11-12T16:18:40Z

Build Succeeded 👏

Build Id: bbd8a3fd-65b7-4c91-a731-4e09981d400a

The following development artifacts have been built, and will exist for the next 30 days:

image: gcr.io/agones-images/agones-controller:1.19.0-a5d7c90
image: gcr.io/agones-images/agones-ping:1.19.0-a5d7c90
Linux C++ SDK (build): agonessdk-1.19.0-a5d7c90-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.19.0-a5d7c90.zip

A preview of the website (the last 30 builds are retained):

https://a5d7c90-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/2343/head:pr_2343 && git checkout pr_2343
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.19.0-a5d7c90

google-oss-prow · 2021-11-15T22:35:25Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aaronchapin-tocaboca, markmandel

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [markmandel]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

markmandel · 2021-11-15T22:35:29Z

Nice work!

google-oss-prow · 2021-11-15T22:35:29Z

New changes are detected. LGTM label has been removed.

agones-bot · 2021-11-16T17:03:22Z

Build Succeeded 👏

Build Id: 0c36225e-53d1-4b9b-8bc7-ee2034fdc9f7

The following development artifacts have been built, and will exist for the next 30 days:

image: gcr.io/agones-images/agones-controller:1.19.0-3c99121
image: gcr.io/agones-images/agones-ping:1.19.0-3c99121
Linux C++ SDK (build): agonessdk-1.19.0-3c99121-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.19.0-3c99121.zip

A preview of the website (the last 30 builds are retained):

https://3c99121-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/2343/head:pr_2343 && git checkout pr_2343
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.19.0-3c99121

aaronchapin-tocaboca added 2 commits October 27, 2021 15:37

Add files to support Unity Package Manager

f2f7809

- Agones assembly definition - Package information - Meta files required for the engine

Update version number

7873509

google-cla bot added the cla: yes label Oct 27, 2021

google-oss-robot added the size/L label Oct 27, 2021

google-oss-robot requested review from pooneh-m and roberthbailey October 27, 2021 14:14

markmandel reviewed Oct 27, 2021

View reviewed changes

Merge branch 'main' into feature/issue-2338-unity-package

64f7b52

roberthbailey reviewed Oct 29, 2021

View reviewed changes

aaronchapin-tocaboca added 2 commits October 29, 2021 11:40

Update author name

c05ae95

Merge branch 'feature/issue-2338-unity-package' of github.com:aaronch…

5ac61b9

…apin-tocaboca/agones into feature/issue-2338-unity-package

aaronchapin-tocaboca changed the title ~~Add files to support Unity Package Manager~~ Support Unity Package Manager Oct 29, 2021

Merge branch 'main' into feature/issue-2338-unity-package

2b2969e

aaronchapin-tocaboca added 2 commits November 1, 2021 16:32

Add update step

931ce7d

Merge branch 'feature/issue-2338-unity-package' of github.com:aaronch…

8a59ace

…apin-tocaboca/agones into feature/issue-2338-unity-package

Merge branch 'main' into feature/issue-2338-unity-package

34c3440

aaronchapin-tocaboca requested review from roberthbailey and markmandel November 4, 2021 09:28

markmandel reviewed Nov 4, 2021

View reviewed changes

aaronchapin-tocaboca added 3 commits November 8, 2021 13:41

Add step to Update SDK Package Versions section

c94f5ad

Merge branch 'main' of github.com:googleforgames/agones into feature/…

bd54e7b

…issue-2338-unity-package

Merge branch 'feature/issue-2338-unity-package' of github.com:aaronch…

5669bda

…apin-tocaboca/agones into feature/issue-2338-unity-package

markmandel reviewed Nov 8, 2021

View reviewed changes

Merge branch 'main' into feature/issue-2338-unity-package

3daebb4

aaronchapin-tocaboca added 3 commits November 12, 2021 16:36

Updated client SDK documentation

1cb6f35

Merge branch 'main' of github.com:googleforgames/agones into feature/…

14c745a

…issue-2338-unity-package

Merge branch 'feature/issue-2338-unity-package' of github.com:aaronch…

a5d7c90

…apin-tocaboca/agones into feature/issue-2338-unity-package

markmandel added area/user-experience Pertaining to developers trying to use Agones, e.g. SDK, installation, etc kind/feature New features for Agones labels Nov 15, 2021

markmandel added this to the 1.19.0 milestone Nov 15, 2021

markmandel approved these changes Nov 15, 2021

View reviewed changes

google-oss-prow bot assigned markmandel Nov 15, 2021

google-oss-prow bot added the lgtm label Nov 15, 2021

google-oss-prow bot added the approved label Nov 15, 2021

Merge branch 'main' into feature/issue-2338-unity-package

eb6e856

google-oss-prow bot removed the lgtm label Nov 15, 2021

markmandel added 2 commits November 15, 2021 15:03

Merge branch 'main' into feature/issue-2338-unity-package

7602eca

Merge branch 'main' into feature/issue-2338-unity-package

3c99121

markmandel merged commit 2be5e3b into googleforgames:main Nov 16, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support Unity Package Manager #2343

Support Unity Package Manager #2343

aaronchapin-tocaboca commented Oct 27, 2021

google-oss-robot commented Oct 27, 2021

agones-bot commented Oct 27, 2021

markmandel Oct 27, 2021

aaronchapin-tocaboca Oct 28, 2021

roberthbailey Oct 29, 2021

aaronchapin-tocaboca Nov 4, 2021

agones-bot commented Oct 28, 2021

roberthbailey left a comment

roberthbailey Oct 29, 2021

roberthbailey Oct 29, 2021

aaronchapin-tocaboca Oct 29, 2021

roberthbailey Oct 29, 2021

aaronchapin-tocaboca Nov 1, 2021

aaronchapin-tocaboca commented Oct 29, 2021

agones-bot commented Oct 29, 2021

agones-bot commented Oct 29, 2021

agones-bot commented Nov 1, 2021

agones-bot commented Nov 3, 2021

markmandel Nov 4, 2021

aaronchapin-tocaboca Nov 8, 2021

agones-bot commented Nov 8, 2021

markmandel commented Nov 8, 2021

markmandel left a comment

agones-bot commented Nov 8, 2021

agones-bot commented Nov 12, 2021

google-oss-prow bot commented Nov 15, 2021

markmandel commented Nov 15, 2021 •

edited

Loading

google-oss-prow bot commented Nov 15, 2021

agones-bot commented Nov 16, 2021

Support Unity Package Manager #2343

Support Unity Package Manager #2343

Conversation

aaronchapin-tocaboca commented Oct 27, 2021

google-oss-robot commented Oct 27, 2021

agones-bot commented Oct 27, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agones-bot commented Oct 28, 2021

roberthbailey left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aaronchapin-tocaboca commented Oct 29, 2021

agones-bot commented Oct 29, 2021

agones-bot commented Oct 29, 2021

agones-bot commented Nov 1, 2021

agones-bot commented Nov 3, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agones-bot commented Nov 8, 2021

markmandel commented Nov 8, 2021

markmandel left a comment

Choose a reason for hiding this comment

agones-bot commented Nov 8, 2021

agones-bot commented Nov 12, 2021

google-oss-prow bot commented Nov 15, 2021

markmandel commented Nov 15, 2021 • edited Loading

google-oss-prow bot commented Nov 15, 2021

agones-bot commented Nov 16, 2021

markmandel commented Nov 15, 2021 •

edited

Loading