Add instructions on how to set up a local development environment for contributing to agones unity sdk
Add instructions on how to set up a local development environment for contributing to agones unity sdk
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 /kind release
What this PR does / Why we need it: This is documentation changes meant for those wanting to contribute to the agones unity sdk. I added a section to the Unity Game Server Client SDK called "Contributing" with instructions on how to set up a local development environment.
Which issue(s) this PR fixes:
Closes #
Special notes for your reviewer:
Build Succeeded :clap:
Build Id: c2313418-82ed-468b-a606-f4a8c54598e1
The following development artifacts have been built, and will exist for the next 30 days:
- image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.42.0-dev-112fa36-amd64
- image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.42.0-dev-112fa36-amd64
- image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.42.0-dev-112fa36-linux-amd64
- image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.42.0-dev-112fa36-amd64
- image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.42.0-dev-112fa36-amd64
- Linux C++ SDK (build): agonessdk-1.42.0-dev-112fa36-amd64-linux-arch_64.tar.gz
- SDK Server: agonessdk-server-1.42.0-dev-112fa36-amd64.zip
A preview of the website (the last 30 builds are retained):
- https://112fa36-dot-preview-dot-agones-images.appspot.com/
To install this version:
git fetch https://github.com/googleforgames/agones.git pull/3886/head:pr_3886 && git checkout pr_3886helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.42.0-dev-112fa36-amd64
Build Failed :scream:
Build Id: 64ecf409-f553-4ec6-8c30-aded3d027e83
To get permission to view the Cloud Build view, join the agones-discuss Google Group.
@markmandel @igooch Please check out the latest version of the code.
As I was making the changes I realized there was an opportunity to standardize on having a README.md in each Agones client SDK directories. The opportunity exists because others have already created README.md files in respective directories.
I altered the plan in the following ways:
- I created a
README.mdfile insdks/unity/directory which contains my explanation for doing Unity package development - I linked to
sdks/unity/README.mdinsdks/README.md, a new file meant to serve as a springboard into each respective client SDK folder - Linked to preexisting
sdk/*/README.mdfiles - Have non-linked text for client SDKs that do not contain
README.md, instead opting to tag them with(todo)text to encourage future development.
These changes are perhaps bigger than what was previously discussed. If we prefer a different approach please let me know and/or send commits!
Build Failed :scream:
Build Id: 7f868c2d-1daf-4523-a251-3e0c58ce05b8
To get permission to view the Cloud Build view, join the agones-discuss Google Group.
Build Succeeded :clap:
Build Id: 387914ed-8ff1-471f-9dec-9bd7df670337
The following development artifacts have been built, and will exist for the next 30 days:
- image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.42.0-dev-dcfb996-amd64
- image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.42.0-dev-dcfb996-amd64
- image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.42.0-dev-dcfb996-linux-amd64
- image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.42.0-dev-dcfb996-amd64
- image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.42.0-dev-dcfb996-amd64
- Linux C++ SDK (build): agonessdk-1.42.0-dev-dcfb996-amd64-linux-arch_64.tar.gz
- SDK Server: agonessdk-server-1.42.0-dev-dcfb996-amd64.zip
A preview of the website (the last 30 builds are retained):
- https://dcfb996-dot-preview-dot-agones-images.appspot.com/
To install this version:
git fetch https://github.com/googleforgames/agones.git pull/3886/head:pr_3886 && git checkout pr_3886helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.42.0-dev-dcfb996-amd64
@igooch @markmandel & @ZeroParticle The build was previous failing but has now since passed. Please review this PR when any of you can!
I also tagged @ZeroParticle especially to review especially what is written in sdks/unity/README.md. I'm hoping they can prove out the written method of setting up a development environment for a Unity Package in Unity (thanks in advance!). I saw PR#3883 and see they're familiar with the subject so figured they'd be a good person to include in this discussion.
Build Succeeded :clap:
Build Id: 54410082-2f31-484a-9ab3-1d64e8e56d6e
The following development artifacts have been built, and will exist for the next 30 days:
- image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.42.0-dev-c4b03e2-amd64
- image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.42.0-dev-c4b03e2-amd64
- image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.42.0-dev-c4b03e2-linux-amd64
- image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.42.0-dev-c4b03e2-amd64
- image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.42.0-dev-c4b03e2-amd64
- Linux C++ SDK (build): agonessdk-1.42.0-dev-c4b03e2-amd64-linux-arch_64.tar.gz
- SDK Server: agonessdk-server-1.42.0-dev-c4b03e2-amd64.zip
A preview of the website (the last 30 builds are retained):
- https://c4b03e2-dot-preview-dot-agones-images.appspot.com/
To install this version:
git fetch https://github.com/googleforgames/agones.git pull/3886/head:pr_3886 && git checkout pr_3886helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.42.0-dev-c4b03e2-amd64
Build Succeeded :clap:
Build Id: c7f60be4-ca16-4333-80d7-c7de491bbdf4
The following development artifacts have been built, and will exist for the next 30 days:
- image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.43.0-dev-97b3c8c-amd64
- image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.43.0-dev-97b3c8c-amd64
- image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.43.0-dev-97b3c8c-linux-amd64
- image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.43.0-dev-97b3c8c-amd64
- image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.43.0-dev-97b3c8c-amd64
- Linux C++ SDK (build): agonessdk-1.43.0-dev-97b3c8c-amd64-linux-arch_64.tar.gz
- SDK Server: agonessdk-server-1.43.0-dev-97b3c8c-amd64.zip
A preview of the website (the last 30 builds are retained):
- https://97b3c8c-dot-preview-dot-agones-images.appspot.com/
To install this version:
git fetch https://github.com/googleforgames/agones.git pull/3886/head:pr_3886 && git checkout pr_3886helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.43.0-dev-97b3c8c-amd64
Added these changes to https://github.com/googleforgames/agones/pull/3887
Build Succeeded :clap:
Build Id: 890d9544-81f6-46bd-a9c5-c02ca56b0c9f
The following development artifacts have been built, and will exist for the next 30 days:
- image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.43.0-dev-efc34d3-amd64
- image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.43.0-dev-efc34d3-amd64
- image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.43.0-dev-efc34d3-linux-amd64
- image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.43.0-dev-efc34d3-amd64
- image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.43.0-dev-efc34d3-amd64
- Linux C++ SDK (build): agonessdk-1.43.0-dev-efc34d3-amd64-linux-arch_64.tar.gz
- SDK Server: agonessdk-server-1.43.0-dev-efc34d3-amd64.zip
A preview of the website (the last 30 builds are retained):
- https://efc34d3-dot-preview-dot-agones-images.appspot.com/
To install this version:
git fetch https://github.com/googleforgames/agones.git pull/3886/head:pr_3886 && git checkout pr_3886helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.43.0-dev-efc34d3-amd64