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

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

core extension oss

Last synced: 6 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/liquibase/ff4j-extension
• Owner: liquibase
• License: apache-2.0
• Created: 2022-05-10T17:08:54.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-30T16:05:40.000Z (about 1 year ago)
• Last Synced: 2025-03-24T09:46:57.738Z (7 months ago)
• Topics: core, extension, oss
• Language: Java
• Homepage:
• Size: 21.5 KB
• Stars: 2
• Watchers: 12
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# FF4J 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 feature flags from FF4J.

## 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 ff4j

```

## Setup

The `ff4j_url` is required for the extension to know where the FF4J server is located. 

```

--ff4j-url=PARAM

     URL for FF4J Server

     (liquibase.ff4j.url)

     (LIQUIBASE_FF4J_URL)

     [deprecated: --ff4jUrl]

```

## Usage

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

     -  ff4jFeatureFlag:

          enabledFlags: changelog-testing

```

```xml

    

        

    

    ...

```

## Feedback and Issues

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