galaxy_store_set_staged_rollout

The Galaxy Store fastlane plugin action galaxy_store_set_staged_rollout enables or disables the staged rollout rate for a given app.

Action

galaxy_store_set_staged_rollout supports a global rollout rate, per-country rates hardcoded in the Fastfile or a JSON file for complex per-country configurations.

galaxy_store_set_staged_rollout(
   ...
)

Parameter

Description

Required

access_token

Galaxy Store API access token

Yes*

service_account_id

Galaxy Store service account ID

Yes*

content_id

12-digit app content ID

Yes

action

ENABLE or DISABLE the staged rollout

Yes

app_status

SALE (live binaries) or REGISTRATION (pending binaries)

Yes

rollout_rate

Global rollout percentage (1-100).

Required when action is ENABLE

No

countries

Array of per-country rollout rates for hardcoding in a Fastfile

No

countries_json_path

Path to a JSON file of per-country rollout rates. Takes precedence over countries

No

*May also be set using environment variables or explicit parameters — see Authentication.

Enable with a global rate

galaxy_store_set_staged_rollout(
    content_id: "000007654321",
    action: "ENABLE",
    app_status: "REGISTRATION",
    rollout_rate: 25
)

Enable with per-country rates hardcoded in the Fastfile

galaxy_store_set_staged_rollout(
    content_id: "000007654321",
    action: "ENABLE",
    app_status: "REGISTRATION",
    rollout_rate: 25,
    countries: [
        { countryCode: "USA", rolloutRate: 40 },
        { countryCode: "KOR", rolloutRate: 45 }
    ]
)

Enable with per-country rates from a JSON file

galaxy_store_set_staged_rollout(
    content_id: "000007654321",
    action: "ENABLE",
    app_status: "REGISTRATION",
    rollout_rate: 25,
    countries_json_path: "fastlane/rollout_countries.json"
)

Where rollout_countries.json contains:

[
    { "countryCode": "USA", "rolloutRate": 40 },
    { "countryCode": "KOR", "rolloutRate": 45 }
]

Disable staged rollout

galaxy_store_set_staged_rollout(
    content_id: "000007654321",
    action: "DISABLE",
    app_status: "REGISTRATION"
)

Results

galaxy_store_set_staged_rollout returns a hash containing the response from the stagedRolloutBinary Content Publish API.