Skip to content

Commit

Permalink
upload-meta-quest-build@v2.1.0 (#21)
Browse files Browse the repository at this point in the history 
- Added additional args for uploading a build directory and symbols zip
- Added glob pattern matching for path inputs
- Convert to TypeScript
  • Loading branch information
@StephenHodgson
StephenHodgson authored Aug 15, 2024
1 parent e403621 commit c4cc7ef
Show file tree
Hide file tree
Showing 10 changed files with 9,770 additions and 4,315 deletions.
32 changes: 17 additions & 15 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ steps:
with:
appId: ${{ secrets.META_APP_ID }}
appSecret: ${{ secrets.META_APP_SECRET }}
apkPath: 'path/to/apk'
buildDir: 'path/to/build/folder'
# use uploaded meta quest build id
- run: 'echo ${{ steps.upload.build_id }}'
```
Expand All @@ -30,21 +30,23 @@ steps:
[Oculus Platform Utility docs](https://developer.oculus.com/resources/publish-reference-platform-command-line-utility/)
| Name | Description | Default | Required |
| Name | Description | Required | Default |
| ---- | ----------- | ------- |----------|
| `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 |
| `ageGroup` | Age group of the build. This can be `TEENS_AND_ADULTS`, `MIXED_AGES`, or `CHILDREN`. (If not specified, the upload will go into “draft” status, rather than failing). For more information, see [Age Group Self-Certification and Youth Requirements](https://developer.oculus.com/resources/age-groups). | true | |
| `appId` | Specifies the ID of your app. Obtained from the API tab of your app in the Oculus Dashboard. | true | |
| `appSecret` |Specifies the app secret. Obtained from the API tab of your app in the Oculus developer dashboard. | Must provide `appSecret` or `token` | |
| `token` | A user token obtained by the get-access-token command or from the API tab of your app in the Oculus developer dashboard. | Must provide `appSecret` or `token` | |
| `apkPath` | Specifies the path to the APK to upload. | true | |
| `obbPath` | Specifies the path to the Expansion file (OBB) to upload. | false | |
| `buildDir` | Specifies the path to the directory that contains the build files. If specified, the plugin will look for the APK and OBB files in this directory. | false | |
| `assetsDir` | Specifies the path to the directory with DLCs for this build. | false | |
| `assetFilesConfig` | Specifies the path to the file that configures required assets or associates DLC assets with in-app purchases. | false | |
| `releaseChannel` | Specifies the release channel for uploading the build. Release channel names are ***not*** case-sensitive. | false | `ALPHA` |
| `releaseNotes` | Specifies the release note text shown to users. Encodes double quotes as `\"`. Encode newlines as `\n`. | false | |
| `languagePacksDir` | The path to the directory that contains language packs. | false | |
| `debugSymbolsDir` | Path to the folder that contains the debug symbol file(s). | false | |
| `debugSymbolsZip` | The path to the debug symbol zip file. If provided this will be used instead of the `debugSymbolsDir` and will unzip before uploading. | false | |
| `debugSymbolsPattern` | 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`. | false | |

### outputs

Expand Down
42 changes: 24 additions & 18 deletions action.yml
View file
Original file line number Diff line number Diff line change
@@ -1,48 +1,54 @@
name: 'Upload Meta Quest Build'
description: 'A GitHub action for uploading a Meta Quest app to the Meta Quest store.'
branding:
icon: upload-cloud
color: blue
icon: 'upload-cloud'
color: 'blue'
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.'
description: 'Age group of the build. This can be TEENS_AND_ADULTS, MIXED_AGES, or CHILDREN. (If not specified, the upload will go into “draft” status, rather than failing). 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.'
description: '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.'
description: 'Specifies the app secret. Obtained from the API tab of your app in the Oculus developer dashboard. Either app secret or user token required.'
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.'
description: 'A user token obtained by the get-access-token command or from the API tab of your app in the Oculus developer dashboard. Either app secret or user token required.'
required: false
apkPath:
description: 'Required. Specifies the path to the APK file to upload.'
required: true
description: 'Specifies the path to the APK to upload. Either apkPath or buildDir is required.'
required: false
obbPath:
description: 'Specifies the path to the Expansion file (OBB) to upload.'
required: false
buildDir:
description: 'Specifies the path to the directory that contains the build files. If specified, the plugin will look for the APK and OBB files in this directory. Either apkPath or buildDir is required.'
required: false
assetsDir:
description: 'Optional Specifies the path to the directory with DLCs for this build.'
description: '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.'
description: 'Specifies the path to the file that configures required assets or associates DLC assets with in-app purchases.'
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.'
description: '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. Defaults to ALPHA.'
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.'
description: 'Specifies the release note text shown to users. Encodes double quotes as `\"`. Encode newlines as `\n`.'
required: false
languagePacksDir:
description: 'Optional. The path to the directory that contains language packs.'
description: 'The path to the directory that contains language packs.'
required: false
debugSymbolsDir:
description: 'Optional. The path to the directory that contains debug symbol files.'
description: 'Path to the folder that contains the debug symbol file(s).'
required: false
debugSymbolsZip:
description: 'The path to the debug symbol zip file. If provided this will be used instead of the debugSymbolsDir and will unzip before uploading.'
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.'
description: '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:
Expand Down
Loading

0 comments on commit c4cc7ef

Please sign in to comment.