Skip to content

Commit 3389814

Browse files
PersomateyPersomatey
authored
Update README.md
1 parent 2746d21 commit 3389814

File tree

1 file changed

+44
-42
lines changed

1 file changed

+44
-42
lines changed

‎README.md‎

Lines changed: 44 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -5,28 +5,27 @@ You can check out the sample app on the [Releases tab](https://github.com/Persom
55

66
## Features
77
- GitHub Releases
8-
- Builds get submitted to the "Releases" tab of your repo as a new release with separate .zip files for each build.
8+
- Builds get submitted to the "Releases" tab of your repo as a new release with separate .zip files for each build.
99
- Last Commit SHA is added to the project via a .json file.
10-
- `\Assets\Data\data.json` in the project which can be displayed in game (on a main menu or something if you want).
11-
- Showcased in the Unity project scene.
10+
- `\Assets\Data\data.json` in the project which can be displayed in game (on a main menu or something if you want).
11+
- Showcased in the Unity project scene.
1212
- Version number is updated to Unity's player and can be accessed using `Application.version`.
1313
- Project name is updated to Unity's player and can be accessed using `Application.productName`.
1414
- Unity Build Profiles
15-
- Under the `buildForAllSupportedPlatforms` job, you can change the `strategy`'s `matrix` and include whatever build profiles you want.
16-
- Showcased in the differences between the built Unity projects, including the defines included in the Build Profiles as displayed in the Unity project scene.
15+
- Under the `buildForAllSupportedPlatforms` job, you can change the `strategy`'s `matrix` and include whatever build profiles you want
16+
- Showcased in the differences between the built Unity projects, including the defines included in the Build Profiles as displayed in the Unity project scene.
1717
- Supports [semantic versioning](https://semver.org/) (MAJOR.MINOR.PATCH).
18-
- Every push increments the PATCH number, with MAJOR and MINOR being incremented maually.
18+
- Every push increments the PATCH number, with MAJOR and MINOR being incremented maually.
1919
- *(Optional)* Parallel builds (to speed up development, but may need to be turned off if memory is exceeding what your runner supports).
20-
- Under the `buildForAllSupportedPlatforms` job, you can change the `strategy`'s `max-parallel` value accordingly.
20+
- Under the `buildForAllSupportedPlatforms` job, you can change the `strategy`'s `max-parallel` value accordingly.
2121
- *(Optional)* Fail fast support, so you're not creating multiple builds if one fails.
22-
- Under the `buildForAllSupportedPlatforms` job, you can change the `strategy`'s `fail-fast` accordingly.
23-
- It's set as `false` by default because sometimes there could be a problem with a single build profile or platform -- but it's there if you're stingy with your runner minutes.
22+
- Under the `buildForAllSupportedPlatforms` job, you can change the `strategy`'s `fail-fast` accordingly.
23+
- It's set as `false` by default because sometimes there could be a problem with a single build profile or platform -- but it's there if you're stingy with your runner minutes.
2424
- *(Optional)* LFS support
25-
- Under the `Checkout repository` step, change the `lfs` value accordingly.
25+
- Under the `Checkout repository` step, change the `lfs` value accordingly.
2626
- *(Optional)* Concurrent workflows
27-
- Under `concurrency`, set the `cancel-in-progress` value accordingly.
28-
- This is mostly to save on runner minutes, but if you don't care about that, leaving it `false` allows you to better track down a bug, especially when collaborating with multiple devs or if you have long build times.
29-
27+
- Under `concurrency`, set the `cancel-in-progress` value accordingly.
28+
- This is mostly to save on runner minutes, but if you don't care about that, leaving it `false` allows you to better track down a bug, especially when collaborating with multiple devs or if you have long build times.
3029

3130
## Workflows
3231

@@ -41,40 +40,43 @@ Build profiles included by default:
4140
- `webgl-dev`: Dev build for WebGL with DEV defines included
4241
- `webgl-rel`: Release build for WebGL with REL defines included
4342

44-
### Versioning (`version-bump.yml`)
43+
### Version Bumping (`version-bump.yml`)
4544
Used to manually version bump the version number. Should be in the format `X.Y.Z`. All future pushes will subsequently start incrementing based on the new MAJOR or MINOR version changes.
46-
- Ex: If the last version before triggering this workflow is `v0.0.42`, and the workflow was triggered with `v0.1.0`, the next `build.yml` workflow run will create the version tag `v0.1.1`.
45+
- Ex: If the last version before triggering this workflow is `v0.0.42`, and the workflow was triggered with `v0.1.0`, the next `build.yml` workflow run will create the version tag `v0.1.1`.
4746

4847
## Set up
49-
1. Find/Generate Unity license
50-
1. Open Unity Hub and log in with your Unity account (if you do not have a current .ulf) then navigate to Preferences > Licenses > Add)
51-
2. Find your `Unity_lic.ulf` file
52-
- Windows: `C:\ProgramData\Unity\Unity_lic.ulf`
53-
- Mac: `/Library/Application Support/Unity/Unity_lic.ulf`
54-
- Linux: `~/.local/share/unity3d/Unity/Unity_lic.ulf`
55-
2. Hook up Unity Credentials
56-
1. On your GitHub repo's, navigate to Setting > Secrets and variables > Actions
57-
2. Create three new Repository secrets
58-
- `UNITY_LICENSE` (Paste the contents of your license file into here)
59-
- `UNITY_EMAIL` (Add the email address that you use to log into Unity)
60-
- `UNITY_PASSWORD` (Add the password that you use to log into Unity)
61-
3. Create initial version tag
62-
1. Navigate to your GitHub version tags page `github.com/username_or_org/repo_name/releases/new`
63-
2. Click "Tag: Select Tag"
64-
3. Set tag to v0.0.0
65-
4. Click "Create"
66-
5. Set "Release title"
67-
6. Click "Publish release"
68-
4. Copy the workflows located in this repo's `.github/workflows/` into your `.github/workflows/` (create this directory if you don't have one already
69-
- `build.yml`
70-
- `version-bump.yml`
71-
5. In `build.yml`'s `buildForAllSupportedPlatforms` step, include the Unity Build Profiles you want generated
48+
1. Fork/clone this repository (rename it to match your package or project)
49+
- Or if you already have a project: Copy the workflows located in this repo's `.github/workflows/` into your `.github/workflows/` (create this directory if you don't have one already
50+
- `.github/workflows/build.yml`
51+
- `.github/workflows/version-bump.yml`
52+
2. Create initial version tag
53+
1. Navigate to your GitHub version tags page `github.com/username_or_org/repo_name/releases/new`
54+
2. Click "Tag: Select Tag"
55+
3. Set tag to v0.0.0
56+
4. Click "Create"
57+
5. Set "Release title"
58+
6. Click "Publish release"
59+
3. Find/Generate Unity license
60+
1. Open Unity Hub and log in with your Unity account (if you do not have a current .ulf) then navigate to Preferences > Licenses > Add)
61+
2. Find your `Unity_lic.ulf` file
62+
- Windows: `C:\ProgramData\Unity\Unity_lic.ulf`
63+
- Mac: `/Library/Application Support/Unity/Unity_lic.ulf`
64+
- Linux: `~/.local/share/unity3d/Unity/Unity_lic.ulf`
65+
4. Hook up Unity Credentials
66+
1. On your GitHub repo's, navigate to Setting > Secrets and variables > Actions
67+
2. Create three new Repository secrets
68+
- `UNITY_LICENSE` (Paste the contents of your license file into here)
69+
- `UNITY_EMAIL` (Add the email address that you use to log into Unity)
70+
- `UNITY_PASSWORD` (Add the password that you use to log into Unity)
71+
5. In `.github/workflows/build.yml`, in the `env`, set the following variables:
72+
- `PROJECT_NAME` (line 18) variable to your project's name
73+
- `UNITY_VERSION`(line 19) variable to your project's Unity version
74+
- `PROJECT_PATH`(line 20) variable to your project's path
75+
76+
5. In `.github/workflows/build.yml` in the `buildForAllSupportedPlatforms` step, include the Unity Build Profiles you want generated
7277
6. In `build.yml`'s `Build with Unity (Build Profile)` step, set the `projectPath` variable to your project folder
7378
7. In `build.yml`'s `Build with Unity (Build Profile)` step, set the `unityVersion` variable to the version of Unity you're using
74-
- Ensure it uses a version of Unity that GameCI supports on their [tags page](https://hub.docker.com/r/unityci/editor/tags)
75-
8. In `build.yml`, in the `env`, set the `PROJECT_NAME` variable to your project's name.
76-
9. In `build.yml`, in the `env`, set the `UNITY_VERSION` variable to your project's Unity version.
77-
10. In `build.yml`, in the `env`, set the `PROJECT_PATH` variable to your project's path.
79+
- Ensure it uses a version of Unity that GameCI supports on their [tags page](https://hub.docker.com/r/unityci/editor/tags)
7880

7981
## Future Plans
8082
*No plans on when I'd release these features, would likely depend on my needs for a specific project/boredom/random interest in moving this project along.*

0 commit comments

Comments
 (0)