https://github.com/liquibase/flipt-extension

Liquibase extension to allow use of Flipt feature flags in changelogs and changesets
https://github.com/liquibase/flipt-extension

core extension oss

Last synced: 2 months ago
JSON representation

Liquibase extension to allow use of Flipt feature flags in changelogs and changesets

• Host: GitHub
• URL: https://github.com/liquibase/flipt-extension
• Owner: liquibase
• License: apache-2.0
• Created: 2022-05-11T03:52:08.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-12T12:07:55.000Z (about 1 year ago)
• Last Synced: 2024-09-12T23:24:11.500Z (about 1 year ago)
• Topics: core, extension, oss
• Language: Java
• Homepage:
• Size: 15.6 KB
• Stars: 1
• Watchers: 12
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Flipt Feature Flags Extension

[Precondition](https://docs.liquibase.com/concepts/changelogs/preconditions.html) to control the execution of a changelog or changeset based on the state of the feature flag in Flipt.

## Supported Editions

[![Community](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/mcred/liquibase-header-footer/feature/badges/badges/community.json)](https://liquibase.org/)

[![Pro](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/mcred/liquibase-header-footer/feature/badges/badges/pro.json)](https://www.liquibase.com/pricing/pro)

## Installation

The easiest way to install this extension is with `lpm` [liquibase package manager](https://github.com/liquibase/liquibase-package-manager).

```shell

lpm update

lpm add flipt

```

## Setup

URL is required for the extension to locate the Flipt API.

```

--flipt-url=PARAM

     URL for Flipt API

     (liquibase.flipt.url)

     (LIQUIBASE_FLIPT_URL)

     [deprecated: --fliptUrl]

```

## Usage

To use this extension, add the `fliptFeatureFlag` 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

```yaml

databaseChangeLog:

  -  preConditions:

     -  fliptFeatureFlag:

          enabledFlags: changelog-testing

```

```xml

    

        

    

    ...

```

## Feedback and Issues

Please submit all feedback and issues to [this idea board](https://ideas.liquibase.com/c/70-flipt-feature-flags-extension).