Release Bundle Usage & API Reference
React Native Stallion CLI Release Bundle API - Learn how to release bundles using Stallion CLI. API reference for OTA update releases.
Prerequisite:
This command requires a CI Token. It will not function without one and is intended specifically for automated workflows.
Generating a CI Token
Before using the release-bundle command, ensure you have generated a CI token via the Stallion Console by navigating to:
Project Settings > Access Tokens > Generate CI Token
Releasing a Bundle
Once you have a valid CI Token, you can release a previously published bundle using the release-bundle command.
Note: The platform is automatically detected based on the platform specified during the bundle publishing step.
stallion release-bundle \
--project-id=<your_project_id> \
--hash=<bundle_hash> \
--app-version=<target_app_version> \
--release-note="Your release note" \
--ci-token=<your_ci_token>
Example
stallion release-bundle \
--project-id=64f5f341a43eb5ccf93548e4 \
--hash=6c8a45dcf5a3e983e389afada81449b2b326b2540758a55ca2227902a55f7e2a \
--app-version=1.0.1 \
--release-note="First test CI release" \
--ci-token=stl_zKNKb6JvW80DemZNomJF8EgxHo-KNcVo_u
Parameters
1. --project-id
Specifies the project ID. You can find this in the Project Settings section of the Stallion Console.
--project-id=your-project-id
2. --hash
The unique hash of the bundle that was published using the publish-bundle command.
--hash=your-bundle-hash
3. --app-version
The target app version that this bundle is associated with. It should match the version of your Android/iOS application.
--app-version=1.0.1
4. --release-note
A short description of what this release contains.
--release-note="your release note"
5. --ci-token
A required token used for CI/CD automation.
--ci-token="your-CI-token"
6. --is-mandatory (Optional, default: false)
Marks the release as mandatory. If not provided, the release is considered optional.
--is-mandatory=true
7. --is-paused (Optional, default: false)
Indicates whether the release should be paused.
--is-paused=true
8. --json (Optional: for scripting)
Available in stallion-cli@2.6.0-alpha.2:
The --json flag is currently available in stallion-cli@2.6.0-alpha.2. Install it with npm install -g stallion-cli@2.6.0-alpha.2.
Prints only a JSON result on stdout (progress and diagnostics go to stderr), so the output can be piped directly into scripts:
{ "id": "6650a2c1…", "version": 12, "appVersion": "1.0.1", "hash": "6c8a45…", "projectId": "64f5f341…" }
See CI Automation & JSON Output for end-to-end pipeline examples.
Note:
Default rollout percent when a bundle is released is 0%. For updating the rollout percent please use update-release command.
Release Automation Using GitHub Actions
To automate the release process using GitHub Actions, refer to the following documentation:
Release Automation using GitHub Actions