CloudBees Feature Management Extension

Note: These feature flag extensions are being deprecated. We will open-source these extensions soon and will update this page when the open source versions of them are available. Please contact support if you have any questions.

Precondition to control the execution of a changelog or changeset based on the state of the feature flag in CloudBees.

Supported Editions

Pro

Installation

The easiest way to install this extension is with lpm liquibase package manager.

Copy
lpm update
lpm add cloudbees-feature-management

Setup

  • API Token is required for the extension to access the CloudBees Feature Management API.
  • Application ID is required for the extension to access the CloudBees Feature Management API.
  • Environment is required for the extension to access the CloudBees Feature Management API.
Copy
--cloud-bees-api-token=PARAM

     API Token for CloudBees Feature Management
     (liquibase.cloudBees.apiToken)
     (LIQUIBASE_CLOUD_BEES_API_TOKEN)
     [deprecated: --cloudBeesApiToken]

--cloud-bees-application-id=PARAM

     Application ID for CloudBees Feature Management
     (liquibase.cloudBees.applicationId)
     (LIQUIBASE_CLOUD_BEES_APPLICATION_ID)
     [deprecated: --cloudBeesApplicationId]

--cloud-bees-environment=PARAM

     Environment for CloudBees Feature Management
     (liquibase.cloudBees.environment)
     (LIQUIBASE_CLOUD_BEES_ENVIRONMENT)
     [deprecated: --cloudBeesEnvironment]

Usage

To use this extension, add the cloudBeesFeatureFlag precondition to your Changelog or Changeset with an enabledFlags attribute. The value for enabledFlags is either a string with one feature flag key or a comma separated string with multiple feature flag keys. All feature flags must be enabled for the precondition to pass.

Example

Copy
databaseChangeLog:
  -  preConditions:
     -  cloudBeesFeatureFlag:
          enabledFlags: changelog-testing
Copy
<changeSet id="1" author="example">
    <preConditions>
        <ext:cloudBeesFeatureFlag enabledFlags="changelog-testing"/>
    </preConditions>
    ...
</changeSet>