Octopus Deploy OpenFeature provider for Java

The OctopusDeploy OpenFeature provider for Java.

This provider works with the OpenFeature Server-Side SDK. It is not intended for use in clients such as browser or desktop applications.

About Octopus Deploy

Octopus Deploy is a sophisticated, best-of-breed continuous delivery (CD) platform for modern software teams. Octopus offers powerful release orchestration, deployment automation, and runbook automation, while handling the scale, complexity and governance expectations of even the largest organizations with the most complex deployment challenges.

Supported Java Versions

This provider will work with Java 11 and above.

Getting Started

Installation

The Octopus OpenFeature provider for Java is currently published to GitHub Packages. It will be published to the Maven Central repository soon.

To add Maven package dependencies from GitHub Packages, you will need to add a Maven repository (in either your settings.xml or pom.xml), and create a GitHub Personal Access Token (classic) with read:packages scope, and configure this to be used to authenticate. An example settings.xml is shown below:

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                      http://maven.apache.org/xsd/settings-1.0.0.xsd">

  <activeProfiles>
    <activeProfile>github</activeProfile>
  </activeProfiles>

  <profiles>
    <profile>
      <id>github</id>
      <repositories>
        <repository>
          <id>central</id>
          <url>https://repo1.maven.org/maven2</url>
        </repository>
        <repository>
          <id>github</id>
          <url>https://maven.pkg.github.com/OctopusDeploy/openfeature-provider-java</url>
          <snapshots>
            <enabled>true</enabled>
          </snapshots>
        </repository>
      </repositories>
    </profile>
  </profiles>

  <servers>
    <server>
      <id>github</id>
      <username>USERNAME</username>
      <password>TOKEN</password>
    </server>
  </servers>
</settings>

Read the GitHub docs for more information on working with GitHub Packages as a Maven registry.

Once this is configured, you can add the Octopus OpenFeature provider as a dependency. The Maven example is shown below.

<dependency>
    <groupId>com.octopus.openfeature</groupId>
    <artifactId>octopus-openfeature-provider</artifactId>
    <version>0.1.0</version> <!-- use current version number -->
</dependency>

Usage

import dev.openfeature.sdk.*;
import com.octopus.openfeature.provider.*;

public class Main {
    
    public static void main(String[] args) {
        var openFeature = OpenFeatureAPI.getInstance();
        openFeature.setProvider(new OctopusProvider(new OctopusConfiguration("Your Octopus client identifier")));
        var openFeatureClient = openFeature.getClient(); 
        
        var darkModeIsEnabled = openFeatureClient.getBooleanValue("dark-mode", false);
    }
}

For information on using the OpenFeature client please refer to the OpenFeature Documentation.