[REG-1495] Reorganize Unity projects and add CI/CD #121

analogrelay · 2023-12-08T23:25:23Z

Warning

When this PR merges, all references to our SDK will have to be updated.
This applies to:

Anyone using our builds from main
Anyone using our builds from 0.0.16 (next release) on.
In addition, we need to update our README when we ship 0.0.16 to provide the correct Git URL.

Note

There's a lot here. I recommend reviewing it commit-by-commit, as it's easier to follow. Use the dropdown in the top-left of the PR review panel:

The first commit moves the existing package in to src/gg.regression.unity.bots and the second commit adds the RGUnityBots project. From there, I'll be adding additional scripts for CI/CD.

This PR refactors our repo so that it has our package, and a "Host" Unity project:

src/gg.regression.unity.bots - The RegressionGames Unity SDK package.
src/RGUnityBots - A barebones 3D Unity game that is used to build and test the Unity SDK package.

The RGUnityBots Unity project references gg.regression.unity.bots via a relative path, so if you build it or run tests, it can validate the Unity SDK itself.

Compilation errors are rendered in the PR files list!

Test results render in the "Details" view for the "Unity Build and Test / Test Results" PR Check:

TODO:

Set up CI/CD. I was going to use GitHub Actions since it's fairly straightforward, but I can look at CircleCI if we'd prefer that.

Blocked by:

I need a Unity License we can use for building
We need to configure that Unity License in the GitHub Actions Secrets for this repo (I don't have permissions for that).

Find the pull request instructions here

Every reviewer and the owner of the PR should consider these points in their request (feel free to copy this checklist so you can fill it out yourself in the overall PR comment)

vontell · 2023-12-11T14:33:19Z

@analogrelay I went and add the Unity license to the UNITY_LICENSE secret in GitHub Actions for this repository - let me know if you need any other permissions, but I believe that should work...

analogrelay · 2023-12-11T18:26:27Z

I think that's all I needed, but I'll let you know!

nAmKcAz · 2023-12-11T20:45:19Z

@analogrelay For the projects we have that reference the sdk by relative path, the PRs for the update can be made beside this for review (that's what I've generally done in the past so they can all merge near in time)

BossRoom
PlatformerSample
HappyHarvestBot-Sample
... others ??

For the GIT reference projects.... needing to update to the latest commit after merging is annoying and prevents the early PRs for the most part. IIRC I think I used unity's package manager to update those hashes after merging last time but there are other ways to do it.

nAmKcAz

Looks good

If we don't have at least one gotcha from this I'll be amazed/impressed, but only one way to find out for sure. Merge it 👍

I wonder if in the future we can do another pass where we put the sample projects we wish to ship in an easier to manipulate location and package them into the SDK during the build.

vontell

Very excited about the possibilities this opens up...

Just to confirm one thing though - when we download via git for the package, it was unclear to me whether the game samples also would be downloaded? Now that I think about it, even though we can define a folder, would the git clone still pull everything?

vontell · 2023-12-11T21:02:35Z

.github/workflows/unity-build.yml

+      - name: Run Unity Tests
+        id: run-unity-tests
+        uses: game-ci/unity-test-runner@v4
+        env:
+          UNITY_LICENSE: ${{ secrets.UNITY_LICENSE }}
+        with:
+          projectPath: src/RGUnityBots
+          githubToken: ${{ secrets.GITHUB_TOKEN }}


So right now this will only run the tests in the SDK, correct? And in the future how should we run tests that are in the games? Also I am guessing we will have a README in this project that mentions things like this?

This builds and run tests on the host project src/RGUnityBots. Ideally, this should be where all our tests live. If we need scenes or assets for test scenarios, I'd suggest they mostly live in src/RGUnityBots so that they aren't expected to be both useful tests and useful samples (as those scenarios can be different).

When/if we add other samples to this repo, we can absolutely add GitHub Actions workflows to build and test them. The "primary" build here is src/RGUnityBots though.

analogrelay · 2023-12-11T21:25:42Z

One piece of clarification: This PR introduces no additional samples into this repo. We can absolutely start merging our existing samples into this repo but I haven't done that immediately because each sample needs a little evaluation to ensure we have an appropriate license to redistribute it since this is a public repo. Our samples are almost entirely from "open-source" content and our own original work, so this should be straightforward, but I didn't want to jump straight in to that right now.

I wonder if in the future we can do another pass where we put the sample projects we wish to ship in an easier to manipulate location and package them into the SDK during the build.

@RG-nAmKcAz

This is largely my plan, though I'm saving it for future PRs. I think the src/gg.regression.unity.bots/Samples~ directory is still necessary and should include the core sample content intended to be packaged "with" the SDK, like our ThirdPartyDemo sample.

We also have the option, in this layout, of creating samples that live outside the SDK package itself, in the samples/ directory (doesn't exist yet). These would be samples we could build and even test as part of building this repo, and are available to users who clone the repo and want to look through more detailed samples, but they don't appear as "part" of the SDK.

Just to confirm one thing though - when we download via git for the package, it was unclear to me whether the game samples also would be downloaded?

@vontell

The Unity SDK package is now in src/gg.regression.unity.bots. This is what you reference in your projects, so out-of-repo projects (some of our samples, and customer games) can either:

Clone this repo and use a file-system reference in to the src/gg.regression.unity.bots (then it's up to them to manage the repo on-disk)
Make a Git reference using the ?path syntax to specify the path to the package, for example: https://github.com/Regression-Games/RGUnityBots.git?path=/src/gg.regression.unity.bots#0.0.16. Unity will clone the repo and handle the reference.

In either case, only the SDK (src/gg.regression.unity.bots) will be integrated into their game. Other files in this repo (such as future samples we put in this repo) will end up on disk (I expect Unity will clone the entire repo) but only the SDK folder contents will end up as Assets in their project.

analogrelay · 2023-12-11T21:26:27Z

For the projects we have that reference the sdk by relative path, the PRs for the update can be made beside this for review (that's what I've generally done in the past so they can all merge near in time)

Yep, that's what I'm working on now.

analogrelay · 2023-12-11T21:33:26Z

Sample Update PRs (I'll be editing this in-place as they are opened):

City Builder: https://github.com/Regression-Games/RGCityBuilder/pull/2
Boss Room: https://github.com/Regression-Games/RGBossRoom/pull/45
Platformer: https://github.com/Regression-Games/PlatformerSample/pull/5
Happy Harvester: https://github.com/Regression-Games/HappyHarvestBot-Sample/pull/1
2D Rogue Like: https://github.com/Regression-Games/RG2DRoguelike/pull/2
Tanks!: https://github.com/Regression-Games/Tanks-Sample/pull/1
Match 3: [REG-1495] Update reference to 'gg.regression.unity.bots' Match3Sample#4
Kart Racer: Does not have Unity SDK installed
Third Person: https://github.com/Regression-Games/RGThirdPersonDemo/pull/5

vontell · 2023-12-11T21:40:17Z

@analogrelay ah yes I guess my concern was the following - I thought the point of this PR was to begin supporting putting our samples into this repo, which sounds like the next steps. However, I am more worried now about the idea that if we do start adding samples, then when a user goes to add our package, even though our SDK folder would be small, they would need to pull gigabytes worth of sample projects that then get thrown away by Unity anyways. That was what I was getting at with my comment, if that makes sense!

analogrelay · 2023-12-11T21:58:00Z

I thought the point of this PR was to begin supporting putting our samples into this repo

I don't believe that's the case. The point of the PR is to be able to build and test the SDK. The fact that we can put samples in here is a bonus, but it's entirely an entirely separate decision IMO.

vontell · 2023-12-11T22:09:32Z

I thought the point of this PR was to begin supporting putting our samples into this repo

I don't believe that's the case. The point of the PR is to be able to build and test the SDK. The fact that we can put samples in here is a bonus, but it's entirely an entirely separate decision IMO.

Ah got it - makes more sense now! Thanks!

analogrelay · 2023-12-11T22:30:00Z

I opened PRs against all our samples, but I want to merge this and my other outstanding PRs first, then update those PRs. For a few reasons:

I may need commit hashes updated
We can get those samples updated with the latest codegen after [REG-1463] Generate 'partial' class to attach RGState and RGAction to host behavior #116 lands.

So, the plan for now is to merge this, then update my other PRs to resolve conflicts (since trying to resolve conflicts here would be a lot).

analogrelay added 3 commits December 8, 2023 15:17

move existing package to 'src/gg.regression.unity.bots'

18bbb1c

add RGUnityBots host project and build scripts

5f3afe4

revert path change since it'll be in the next release

5a0f95c

analogrelay added 3 commits December 11, 2023 10:44

add a build workflow

1202b87

Merge branch 'main' into ashley/reg-1495

6b127dc

set projectPath correctly

558e770

analogrelay force-pushed the ashley/reg-1495 branch 2 times, most recently from fe5127f to ebdd47e Compare December 11, 2023 19:11

add problem matcher

594fd78

analogrelay force-pushed the ashley/reg-1495 branch from ebdd47e to 594fd78 Compare December 11, 2023 19:29

analogrelay added 3 commits December 11, 2023 11:38

remove compilation error

315fa3e

fix missing file?

ddf788c

fix intentional errors

8d671ee

analogrelay marked this pull request as ready for review December 11, 2023 20:23

analogrelay requested review from nAmKcAz, vontell, rcornwall-reg, addisonbgross and abeizer December 11, 2023 20:23

nAmKcAz approved these changes Dec 11, 2023

View reviewed changes

vontell approved these changes Dec 11, 2023

View reviewed changes

analogrelay mentioned this pull request Dec 11, 2023

[REG-1495] Update reference to 'gg.regression.unity.bots' Regression-Games/Match3Sample#4

Merged

1 task

analogrelay merged commit 06842de into main Dec 11, 2023
2 checks passed

analogrelay deleted the ashley/reg-1495 branch December 11, 2023 22:30

This was referenced Dec 11, 2023

[REG-1524] Don't allow RGState on delegates anymore #119

Merged

[REG-1488] Prompt for new bot name and decouple local bots from their IDs #115

Merged

addisonbgross pushed a commit that referenced this pull request Sep 24, 2024

[REG-1495] Reorganize Unity projects and add CI/CD (#121)

e57abd9

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[REG-1495] Reorganize Unity projects and add CI/CD #121

[REG-1495] Reorganize Unity projects and add CI/CD #121

analogrelay commented Dec 8, 2023 •

edited

Loading

vontell commented Dec 11, 2023

analogrelay commented Dec 11, 2023

nAmKcAz commented Dec 11, 2023 •

edited

Loading

nAmKcAz left a comment

vontell left a comment

vontell Dec 11, 2023

analogrelay Dec 11, 2023

analogrelay commented Dec 11, 2023

analogrelay commented Dec 11, 2023

analogrelay commented Dec 11, 2023 •

edited

Loading

vontell commented Dec 11, 2023 •

edited

Loading

analogrelay commented Dec 11, 2023 •

edited

Loading

vontell commented Dec 11, 2023

analogrelay commented Dec 11, 2023

[REG-1495] Reorganize Unity projects and add CI/CD #121

[REG-1495] Reorganize Unity projects and add CI/CD #121

Conversation

analogrelay commented Dec 8, 2023 • edited Loading

vontell commented Dec 11, 2023

analogrelay commented Dec 11, 2023

nAmKcAz commented Dec 11, 2023 • edited Loading

nAmKcAz left a comment

Choose a reason for hiding this comment

vontell left a comment

Choose a reason for hiding this comment

vontell Dec 11, 2023

Choose a reason for hiding this comment

analogrelay Dec 11, 2023

Choose a reason for hiding this comment

analogrelay commented Dec 11, 2023

analogrelay commented Dec 11, 2023

analogrelay commented Dec 11, 2023 • edited Loading

vontell commented Dec 11, 2023 • edited Loading

analogrelay commented Dec 11, 2023 • edited Loading

vontell commented Dec 11, 2023

analogrelay commented Dec 11, 2023

analogrelay commented Dec 8, 2023 •

edited

Loading

nAmKcAz commented Dec 11, 2023 •

edited

Loading

analogrelay commented Dec 11, 2023 •

edited

Loading

vontell commented Dec 11, 2023 •

edited

Loading

analogrelay commented Dec 11, 2023 •

edited

Loading