Skip to content

Commit

Permalink
Update docs to reflect changes in unity builder PR#505 (#362)
Browse files Browse the repository at this point in the history
  • Loading branch information
AndrewKahr authored Feb 14, 2023
1 parent 99f1595 commit b57ef92
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 1 deletion.
43 changes: 43 additions & 0 deletions docs/03-github/04-builder.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -292,8 +292,31 @@ Configure the android `versionCode`.
When not specified, the version code is generated from the version using the
`major * 1000000 + minor * 1000 + patch` scheme;

#### androidExportType

Set this flag to `androidPackage` to build an apk, `androidAppBundle` for an aab, or
`androidStudioProject` to build an Android Studio Project.

```yaml
- uses: game-ci/unity-builder@v2
with:
androidExportType: 'androidAppBundle'
androidKeystoreName: user.keystore
androidKeystoreBase64: ${{ secrets.ANDROID_KEYSTORE_BASE64 }}
androidKeystorePass: ${{ secrets.ANDROID_KEYSTORE_PASS }}
androidKeyaliasName: ${{ secrets.ANDROID_KEYALIAS_NAME }}
androidKeyaliasPass: ${{ secrets.ANDROID_KEYALIAS_PASS }}
```

You should also set all the Android Keystore options (see below). Refer to (this
section)[/docs/github/deployment/android#3-generate-an-upload-key-and-keystore] for keystore setup.

_**required:** `false`_ _**default:** `androidPackage`_

#### androidAppBundle

**[Deprecated] Please use androidExportType instead.**

Set this flag to `true` to build '.aab' instead of '.apk'.

```yaml
Expand Down Expand Up @@ -360,6 +383,12 @@ Configure the android target API level. If used, must be one of

_**required:** `false`_ _**default:** `""`_

#### androidSymbolType

Export android symbols alongside the build. Can be set to `none`, `public`, or `debugging`.

_**required:** `false`_ _**default:** `"none"`_

#### sshAgent

SSH Agent path to forward to the container.
Expand Down Expand Up @@ -404,6 +433,20 @@ Sets the url to a unity license server for acquiring floating licenses.

_**required:** `false`_ _**default:** `""`_

#### cacheUnityInstallationOnMac

Enables caching the Unity Hub and Editor installation for MacOS runners. This can significantly
reduce project build times if you have enough available cache on Github Actions.

_**required:** `false`_ _**default:** `false`_

#### unityHubVersionOnMac

Allows pinning the Unity Hub version used on MacOS runners. Should be of format `Major.Minor.Patch`,
ie `3.4.0`. An empty string represents the latest available version on homebrew.

_**required:** `false`_ _**default:** `""`_

## Outputs

Below are outputs that can be accessed by using `${{ steps.myBuildStep.outputs.outputName }}`, where
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"engines": {
"npm": "please-use-yarn",
"yarn": ">= 1.22.4",
"node": "16.x"
"node": ">= 16.x"
},
"scripts": {
"prepare": "lefthook install && npx husky uninstall -y",
Expand Down

1 comment on commit b57ef92

@vercel
Copy link

@vercel vercel bot commented on b57ef92 Feb 14, 2023

Choose a reason for hiding this comment

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

Please sign in to comment.