Skip to content

V3 Docs Update#384

Closed
AndrewKahr wants to merge 1 commit into
mainfrom
v3-docs
Closed

V3 Docs Update#384
AndrewKahr wants to merge 1 commit into
mainfrom
v3-docs

Conversation

@AndrewKahr

Copy link
Copy Markdown
Member

Changes

  • Created V2 Docs Version
  • Added V3 Changes as Current Docs

Checklist

  • Read the contribution guide and accept the
    code of conduct
  • Readme (updated or not needed)
  • Tests (added, updated or not needed)

@AndrewKahr AndrewKahr requested a review from davidmfinol March 29, 2023 03:51
@github-actions

Copy link
Copy Markdown

Cat Gif

@AndrewKahr AndrewKahr requested a review from webbertakken March 29, 2023 03:51
@github-actions

Copy link
Copy Markdown

Visit the preview URL for this PR (updated for commit 48086a4):

https://game-ci-5559f--pr384-v3-docs-od7w2su2.web.app

(expires Wed, 05 Apr 2023 03:54:31 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 1f0574f15f83e11bfc148eae8646486a6d0e078b

@webbertakken webbertakken left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Your description is missing why we're moving from version 2 to 3.

Do we really need to bump versions already if all we're doing is removing a deprecated parameter?

If the changes are largely in cloud-runner I'd suggest sticking with v2.x until we have actual breaking changes in our public interface.

Comment thread docusaurus.config.js
Comment on lines 51 to +59
current: {
label: 'v2 (current)',
label: 'v3 (current)',
},
1: {
label: 'v1',
},
2: {
label: 'v2',
},

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Versions should be in descending order, not like this:
image

Comment on lines 316 to +318
#### androidAppBundle

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

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

```yaml
- uses: game-ci/unity-builder@v2
with:
androidAppBundle: true
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:** `false`_
**[Removed in V3] Please use androidExportType instead.**

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Lets not document removed properties.

@webbertakken

Copy link
Copy Markdown
Member

@AndrewKahr is this PR still needed, or did you port over all changes to #407?

@AndrewKahr AndrewKahr closed this Aug 22, 2023
@AndrewKahr

Copy link
Copy Markdown
Member Author

I ported it over, closing this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants