Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
- Initial Release! 🎉🚀
  • Loading branch information
StephenHodgson authored Aug 8, 2024
1 parent f5aef17 commit bfae622
Show file tree
Hide file tree
Showing 11 changed files with 28,716 additions and 2 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @buildalon/buildalon
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules
55 changes: 53 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,53 @@
# upload-meta-quest-build
A GitHub Action for uploading a Meta Quest app to the Meta Quest store.
# Buildalon Upload Meta Quest Build

[![Discord](https://img.shields.io/discord/939721153688264824.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/VM9cWJ9rjH)

A GitHub Action for [uploading a Meta Quest app to the Meta Quest store](https://developer.oculus.com/resources/publish-reference-platform-command-line-utility/#upload-quest).

## How to use

* [Get Credentials](https://developer.oculus.com/resources/publish-reference-platform-command-line-utility/#credentials)
* Set repo secrets
* `META_APP_ID`
* `META_APP_SECRET`

### workflow

```yaml
steps:
# setup ovr platform util
- uses: buildalon/setup-ovr-platform-util@v1
# upload meta quest build
- uses: buildalon/upload-meta-quest-build@v2
id: upload
with:
appId: ${{ secrets.META_APP_ID }}
appSecret: ${{ secrets.META_APP_SECRET }}
apkPath: 'path/to/apk'
# use uploaded meta quest build id
- run: 'echo ${{ steps.upload.build_id }}'
```
### inputs
[Oculus Platform Utility docs](https://developer.oculus.com/resources/publish-reference-platform-command-line-utility/)
| Name | Description | Default | Required |
| ---- | ----------- | ------- |----------|
| `ageGroup` | Age group of the build. This can be `TEENS_AND_ADULTS`, `MIXED_AGES`, or `CHILDREN`. | | Yes |
| `appId` | Your App ID from the meta store | | Yes |
| `appSecret` | Your App secret from the meta store | | Must provide appSecret or token |
| `token` | The App ID from the meta store | | Must provide appSecret or token |
| `apkPath` | Path to the APK to upload | | Yes |
| `obbPath` | Path to an obb file to upload | | No |
| `assetsDir` | DLC Content to upload | | No |
| `releaseChannel` | Which release channel to upload the apk to | `ALPHA` | No |
| `releaseNotes` | Release notes to upload | | No |
| `assetFilesConfig` | DLC Config | | No |
| `languagePacksDir` | Additional languages | | No |
| `debugSymbolsDir` | Path to the folder that contains the debug symbol file(s) | | No |
| `debugSymbolsPattern` | Specifies a file pattern that matches the files names of all debug symbol files | | No |

### outputs

* `build_id`: The uploaded build id.
52 changes: 52 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: 'Buildalon Upload Meta Quest Build'
description: 'A GitHub action for uploading a Meta Quest app to the Meta Quest store.'
branding:
icon: 'upload-cloud'
color: 'red'
inputs:
ageGroup:
description: 'Required. (If not specified, the upload will go into “draft” status, rather than failing.) Age group of the build. This can be TEENS_AND_ADULTS, MIXED_AGES, or CHILDREN. For more information, see Age Group Self-Certification and Youth Requirements.'
required: true
appId:
description: 'Required. Specifies the ID of your app. Obtained from the API tab of your app in the Oculus Dashboard.'
required: true
appSecret:
description: 'Either app secret or user token required. Specifies the app secret. Obtained from the API tab of your app in the Oculus developer dashboard.'
required: false
token:
description: 'Either app secret or user token required. A user token obtained by the get-access-token command or from the API tab of your app in the Oculus developer dashboard.'
required: false
apkPath:
description: 'Required. Specifies the path to the APK file to upload.'
required: true
assetsDir:
description: 'Optional Specifies the path to the directory with DLCs for this build.'
required: false
assetFilesConfig:
description: 'Optional. Specifies the path to the file that configures required assets or associates DLC assets with in-app purchases.'
required: false
obbPath:
description: 'Optional. Specifies the path to the Expansion file (OBB) to upload.'
required: false
releaseChannel:
description: 'Defaults to ALPHA. Specifies the release channel for uploading the build. Use store for the "Production (AppLab)" or "Production (Store)" channels. Release channel names are not case-sensitive.'
required: false
default: 'ALPHA'
releaseNotes:
description: 'Optional. Specifies the release note text shown to users. Enclose the text in quotation marks. Encodes double quotes as \". Encode newlines as \n.'
required: false
languagePacksDir:
description: 'Optional. The path to the directory that contains language packs.'
required: false
debugSymbolsDir:
description: 'Optional. The path to the directory that contains debug symbol files.'
required: false
debugSymbolsPattern:
description: 'Optional. A pattern sequence that can match the filenames of all the debug symbol files. An asterisk may be used to indicate a wildcard, for example, *.sym.so.'
required: false
outputs:
build_id:
description: 'The ID of the build that was uploaded.'
runs:
using: 'node20'
main: 'dist/index.js'
Loading

0 comments on commit bfae622

Please sign in to comment.