Bootstraps a settings build for Helix by configuring plugin resolution, version alignment, repositories, and the Helix version catalog. The version declared on this plugin is the Helix version for the entire project.
- Adds Gradle Plugin Portal, Maven Central, and Sonatype snapshots to pluginManagement.
- Forces all com.helixframework plugin requests to use the same version.
- Creates the helix version catalog from com.helixframework:helix-versioncatalog.
- Applies the Plugin Repos and Recursive Include settings plugins.
Usage
settings.gradle
Groovy DSL
plugins {
id 'com.helixframework.settings' version '<helix-version>'
}
settings.gradle.kts
Kotlin DSL
plugins {
id("com.helixframework.settings") version "<helix-version>"
}
Configuration
No Helix-specific extension is added by this plugin.
Default Behavior
- No Helix-specific extension is added.
- This is the normal entry point for settings.gradle or settings.gradle.kts in Helix-based builds.
- If you want to upgrade or downgrade Helix for a project, change the version on
com.helixframework.settings. - That one version is reused for the other Helix plugins and for the
helixversion catalog in the build.