Update Release Usage & API Reference

Generating a CI Token

Before using the update-release command, ensure you have generated a CI token via the Stallion Console by navigating to:
Project Settings > Access Tokens > Generate CI Token

Updating a Release

Once you have a valid CI Token, you can update an existing release — rollout percentage, pause state, rollback, and more — using the update-release 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

3. --release-note (Optional)
A short description of what this release contains.

--release-note="your release note"

4. --ci-token
A required token used for CI/CD automation.

--ci-token="your-CI-token"

5. --is-mandatory (Optional, default: false)
Marks the release as mandatory. If not provided, the release is considered optional.

--is-mandatory=true

6. --is-paused (Optional, default: false)
Indicates whether the release should be paused.

--is-paused=true

7. --is-rolled-back (Optional, default: false)
Indicates whether the release should be rolled back to a previous stable version.

--is-rolled-back=true

8. --rollout-percent (Optional)
Sets the rollout percentage of the release (0–100). Useful for phased rollouts — start low and ramp up.

--rollout-percent=50

9. --json (Optional: for scripting)

Prints only a JSON result of the updated fields on stdout (progress and diagnostics go to stderr), so the output can be piped directly into scripts:

{ "projectId": "64f5f341…", "hash": "6c8a45…", "rolloutPercent": 50, "isMandatory": true, "isPaused": false, "isRolledBack": false }

See CI Automation & JSON Output for end-to-end pipeline examples.

Release Automation Using GitHub Actions

To automate the release process using GitHub Actions, refer to the following documentation:
Release Automation using GitHub Actions