Progressive rollout

A progressive rollout allows you to change the value of your flag over time.

Example

YAML

progressive-flag:
  variations:
    variationA: A
    variationB: B
  defaultRule:
    progressiveRollout:
      initial:
        variation: variationA
        date: 2024-01-01T05:00:00.100Z
      end:
        variation: variationB
        date: 2024-01-05T05:00:00.100Z

JSON

{
  "progressive-flag": {
    "variations": {
      "variationA": "A",
      "variationB": "B"
    },
    "defaultRule": {
      "progressiveRollout": {
        "initial": {
          "variation": "variationA",
          "date": "2024-01-01T05:00:00.100Z"
        },
        "end": {
          "variation": "variationB",
          "date": "2024-01-05T05:00:00.100Z"
        }
      },
    }
  }
}

TOML

[progressive-flag.variations]
variationA = "A"
variationB = "B"
[progressive-flag.defaultRule.progressiveRollout.initial]
variation = "variationA"
date = 2024-01-01T05:00:00.100Z

[progressive-flag.defaultRule.progressiveRollout.end]
variation = "variationB"
date = 2024-01-05T05:00:00.100Z

• Before the initial date, the flag will return variationA
• Between the initial and end date, the flag will gradually shift to return variationB instead of variationA.
• After the end date, the flag will return variationB.

Using the percentage field (advanced)

If you intend to partially rollout or keep both features.

YAML

    progressiveRollout:
      initial:
        variation: variationA
        percentage: 20   
        date: 2024-01-01T05:00:00.100Z
      end:
        variation: variationB
        percentage: 80
        date: 2024-01-05T05:00:00.100Z

JSON

      "progressiveRollout": {
        "initial": {
          "variation": "variationA",
          "percentage": 20,
          "date": "2024-01-01T05:00:00.100Z"
        },
        "end": {
          "variation": "variationB",
          "percentage": 80,
          "date": "2024-01-05T05:00:00.100Z"
        }
      }

TOML

[progressive-flag.defaultRule.progressiveRollout.initial]
variation = "variationA"
percentage = 20
date = 2024-01-01T05:00:00.100Z

[progressive-flag.defaultRule.progressiveRollout.end]
variation = "variationB"
percentage = 80
date = 2024-01-05T05:00:00.100Z

• Before the initial date, the flag will return variationB 20% of the time and variationA 80% of the time.
• Between the initial and end date, the flag will gradually shift to return variationB more instead of variationA.
• After the end date, the flag will return variationB 80% of the time and variationA 20% of the time.
• This may not be intuitive. It starts with variationA as the dominant response and gradually shifts towards variationB.

Configuration fields

info

The dates are in the format supported natively by your flag file format.

Field	Description
initial	The initial state of this flag. variation is the variation you intend to switch from. date is the date to start the rollout.
end	The end state of this flag. variation is the variation you intend to switch to. date is the date when rollout is completed.
percentage (optional)	It represents the ramp of progress, at which level the flag starts (initial) and ends (end). Default: initial = 0 and end = 100.