How to submit an App SDK
Submitting an App SDK will allow you to offer the app to customers to download and use.
This guide assumes you've completed the getting started guide.
- Open a Terminal or Command window and enter the build command (
nx run [name-of-your-app]:build) to build your App SDK.
npx nx run [name-of-your-app]:build
- Verify the Name and Version number in the package.json in the
dist/apps/[name-of-your-app]. When the App SDK is submitted, the name and version fields combine to create a unique identifier for the app.
"name": "[name-of-your-app]"
"version": "1.0.0",
- Enter the submit command (
nx run [name-of-your-app]:submitApp) to submit your app for approval.
npx nx run [name-of-your-app]:submitApp
-
Accept the developer terms and conditions) by typing
acceptwhen prompted. -
A browser will open, asking you to authenticate your ID. Use your Trackunit manager credentials to authenticate your ID. It will inform you your device is activated.
By device it refers to the command line interface.
-
Once the submit is complete it will show
🚀 Uploaded the app package version 1.0.0.
Remember to bump the version number inside apps/[name-of-your-app]/package.json before you build and submit!
It is not possible to submit the same version multiple times.
When running in a CI pipeline, you can automate the submit step without interactive prompts:
- Accept the developer terms and conditions by setting
TU_DEV_TERMS_AND_CONDITIONS=accept - Supply your access token via the
TU_TOKENenvironment variable
Generating a TU_TOKEN:
- Log in to Trackunit Manager
- Open the Developer Console (available once your account has developer access enabled)
- Navigate to API Tokens and create a new token with the
app:publishscope - Copy the token and add it as a secret in your CI environment (e.g.
TU_TOKENin GitHub Actions secrets)
Example GitHub Actions step:
- name: Submit IrisX App
run: |
npx nx run my-app:submitApp
env:
TU_TOKEN: ${{ secrets.TU_TOKEN }}
TU_DEV_TERMS_AND_CONDITIONS: accept