Arciphant setup

Prerequisites, compatibility and how to include Arciphant in your Gradle build.

Include Arciphant in your build

Arciphant is published to the Gradle Plugin Portal. To integrate it, apply the plugin in your settings.gradle.kts:

plugins {
  id("ch.ergon.arciphant") version "0.2.0"
}

arciphant {
  // your arciphant config
}

The plugin portal page always shows the latest available version.

Prerequisites

JVM plugin

To use Arciphant in your Gradle build, you have to apply either the Kotlin JVM or the Java Library (java-library) plugin to all projects managed by Arciphant — the component and bundle projects in the project layout, the module and bundle projects in the source set layout. This is necessary since Arciphant uses the JVM-specific configurations api and implementation registered by these plugins.

A simple way to do this is a subprojects block in the root project’s build.gradle.kts:

plugins {
  kotlin("jvm") version "2.2.0" apply false
}

subprojects {
  apply(plugin = "org.jetbrains.kotlin.jvm")
}

In larger builds, the JVM plugin is typically applied by convention plugins instead — see Using Plugins.

Compatibility