Helix Framework Documentation

Plugin

Spring Boot Web

Plugin ID
com.helixframework.springboot-web
Plugin Type
Project

Applies the Helix baseline for Spring Boot web services, including runtime, testing, dependency, and local-development defaults.

  • Applies idea, java, application, Build Version, Dependency Management, Dependency Lock, OpenRewrite, and Test Unit.
  • Applies Spring Boot, git-properties, test logger, and gitignore support.
  • Adds the Helix and Spring Boot BOMs and standard web, actuator, logging, and test dependencies.
  • Configures springBoot.buildInfo().
  • Writes build/version and build/artifact metadata during processResources.

Tasks

  • bootRunDebug: Runs the Spring Boot service in debug mode on port 5005 and applies the local profile when no profile is already set.

Usage

build.gradle

Groovy DSL

plugins {
    id 'com.helixframework.springboot-web'
}

build.gradle.kts

Kotlin DSL

plugins {
    id("com.helixframework.springboot-web")
}

Configuration

No Helix-specific extension is added by this plugin.

Default Behavior

  • No Helix-specific extension is added.
  • Java source compatibility is set to 17.
  • bootRun automatically applies the local profile unless SPRING_PROFILES_ACTIVE is already defined.