Plugin

Helix Config

Plugin ID
com.helixframework.config
Plugin Type
Project

Installs and updates the .helix configuration directory from the Helix conventions configuration artifact.

  • Can only be applied to the root project.
  • Creates a helix configuration that resolves the helix-conventions-config ZIP.
  • Installs .helix automatically when the directory is missing and registers a task to refresh it later.

Tasks

  • updateHelixConfig: Installs or refreshes the contents of the root .helix directory from the resolved configuration ZIP.

Usage

build.gradle

Groovy DSL

plugins {
    id 'com.helixframework.config'
}

build.gradle.kts

Kotlin DSL

plugins {
    id("com.helixframework.config")
}

Configuration

This plugin does not create a Helix-specific extension. Configure it through the following properties or helper methods.

  • --ver (default: current Helix build version): Task option for updateHelixConfig that resolves a specific helix-conventions-config version instead of the current Helix version.