Update Release Usage & API Reference
This section contains usage and APIs provided by the CLI for updating a release.
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 update-release \
--project-id=<your_project_id> \
--hash=<bundle_hash> \
--release-note="Updated release note" \
--rollout-percent=<percent> \
--is-mandatory=<true|false> \
--ci-token=<your_ci_token>
Example
stallion update-release \
--project-id=64f5f341a43eb5ccf93548e4 \
--hash=6c8a45dcf5a3e983e389afada81449b2b326b2540758a55ca2227902a55f7e2a \
--release-note="First test CI release" \
--rollout-percent=27 \
--is-mandatory=true \
--ci-token=stl_zKNKb6JvW80DemZNomJF8EgxHo
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
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. --is-rolled-back
(Optional, default: false)
Indicates whether the release should be rolled back to a previous stable version.
--is-rolled-back=true
9. --rollout-percent
(Optional, default: false)
--is-rolled-back=true
Release Automation Using GitHub Actions
To automate the release process using GitHub Actions, refer to the following documentation:
Release Automation using GitHub Actions