https://github.com/sureshg/build-commons
✨ Gradle plugins and catalog for Kotlin JVM, GraalVM and Multiplatform (Native/JS/WASM/WASI) development!
https://github.com/sureshg/build-commons
graalvm gradle gradle-kotlin-dsl java js jvm kotlin kotlin-js kotlin-jvm kotlin-multiplatform kotlin-native kotlin-wasm openjdk wasi wasm
Last synced: about 1 month ago
JSON representation
✨ Gradle plugins and catalog for Kotlin JVM, GraalVM and Multiplatform (Native/JS/WASM/WASI) development!
- Host: GitHub
- URL: https://github.com/sureshg/build-commons
- Owner: sureshg
- Created: 2024-09-29T05:28:03.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-03-27T22:57:48.000Z (about 2 months ago)
- Last Synced: 2025-03-27T23:01:16.921Z (about 2 months ago)
- Topics: graalvm, gradle, gradle-kotlin-dsl, java, js, jvm, kotlin, kotlin-js, kotlin-jvm, kotlin-multiplatform, kotlin-native, kotlin-wasm, openjdk, wasi, wasm
- Language: Kotlin
- Homepage:
- Size: 829 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
🐘 Common Build Plugins
----------
[![GitHub Workflow Status][gha_badge]][gha_url]
[![Maven Central Version][maven_img]][maven_url]
[![OpenJDK Version][java_img]][java_url]
[![Kotlin release][kt_img]][kt_url]
Gradle project and settings [plugins](https://docs.gradle.org/current/samples/sample_convention_plugins.html) to
simplify the bootstrapping of `Kotlin/Java` projects targeting JVM, Multiplatform (Native/JS/Wasm/Wasi), and GraalVM
native-image. The plugin will take care of configuring most common build tasks, including:
* `Maven Central` & `GHCR` publishing for artifacts & Container image (`Jib`)
* Code coverage supporting `JVM`, `Kotlin Multiplatform` projects
* Project Versioning (`SemVer`) based on `Git tags`
* Code Formatting to enforce a consistent code style
* Artifact Signing
* Java/Kotlin Toolchains configuration
* Target platforms (`JVM`, `JS`, `WASM`, `WASI`, `Native`) configuration
* Testing & Reports
* `KSP` & Annotation processors
* `GraalVM Native` Image
* Documentation (`JavaDoc`, `Dokka`)
* Benchmarking (`JMH`)
* API binary compatibility validation
* Deprecated API scanning (using `jdeprscan`)
* Builds truly executable JAR files
* Build config generation
* Version catalog to control artifact versions and build configurations
* Automatic configuration of essential dependencies such as:
* `kotlinx-datetime`
* `kotlinx-coroutines`
* `ktor-client`,
* `kotlinx-serialization`
* `kotlinx-io`
* `Logging`
* Automatic configuration of `compiler plugins` like
* `redacted`
* `kopy`
* `power-assert`
* `atomicfu`
* And other common build tasks.
This plugin helps you focus on writing code, not configuring your build. It provides a solid foundation for your
Kotlin/Java projects, handling the boilerplate and common tasks so you can get started quickly.
## Dev Env Setup
* Install Java 21 or later
```bash
$ curl -s "https://get.sdkman.io" | bash
$ sdk i java 21.0.6-zulu
```
* Import the Gradle project. The initial sync may take some time as it downloads all dependencies.
> [!IMPORTANT]
> For a better, faster experience, use the latest version of [IntelliJ IDEA](https://www.jetbrains.com/idea/download).
> Upgrade now!
## Build & Testing
```bash
$ ./gradlew build
# Check dep updates
$ ./gradlew dependencyUpdates --no-configuration-cache
```
For testing, a separate [sandbox project](/sandbox) is available with the plugin and version catalog applied in
`settings.gradle.kts`. First publish the plugin to the local maven repository and then run the sandbox project.
```bash
# Publish the plugins to maven local
$ ./gradlew publishToMavenLocal
# Build the sandbox app using published plugin
$ ./gradlew -p sandbox :build -PjvmArgs=
$ sandbox/build/libs/sandbox-app
# Run other plugin tasks
$ ./gradlew -p sandbox :dependencyUpdates --no-configuration-cache
# To see the plugin classpath
$ ./gradlew -p sandbox :buildEnvironment | grep -i "dev.suresh"
```
## Publishing
Push a new tag to trigger the release workflow and publish the plugin
to [maven central](https://repo.maven.apache.org/maven2/dev/suresh/build/). That's it 🎉.
The next version will be based on the semantic version scope (`major`, `minor`, `patch`)
```bash
$ ./gradlew pushSemverTag "-Psemver.scope=patch"
# To see the current version
# ./gradlew v
# Print the new version
# ./gradlew printSemver "-Psemver.scope=patch"
# For a specific version
# git tag -am "v1.2.3 release" v1.2.3
# git push origin --tags
```
## Published Plugins
| **Gradle Plugin ID** | **Version** |
|--------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `dev.suresh.plugin.root` | [][plugins_url] |
| `dev.suresh.plugin.common` | [][plugins_url] |
| `dev.suresh.plugin.graalvm` | [][plugins_url] |
| `dev.suresh.plugin.kotlin.jvm` | [][plugins_url] |
| `dev.suresh.plugin.kotlin.mpp` | [][plugins_url] |
| `dev.suresh.plugin.kotlin.docs` | [][plugins_url] |
| `dev.suresh.plugin.kotlin.benchmark` | [][plugins_url] |
| `dev.suresh.plugin.publishing` | [][plugins_url] |
| `dev.suresh.plugin.repos` | [][plugins_url] |
| `dev.suresh.plugin.catalog` | [][plugins_url] |
## How to use it?
- Apply the following config to `settings.gradle.kts` of your project
```kotlin
pluginManagement {
resolutionStrategy {
eachPlugin {
if (requested.id.id.startsWith("dev.suresh.plugin")) {
useVersion("")
}
}
}
repositories {
gradlePluginPortal()
mavenCentral()
}
}
plugins { id("dev.suresh.plugin.repos") }
```
- Apply the required plugins to `root` or `sub` project `build.gradle.kts`
```kotlin
// Kotlin JVM
plugins {
id("dev.suresh.plugin.root")
id("dev.suresh.plugin.kotlin.jvm")
id("dev.suresh.plugin.publishing")
// id("dev.suresh.plugin.graalvm")
application
}
// Kotlin Multiplatform
plugins {
id("dev.suresh.plugin.root")
id("dev.suresh.plugin.kotlin.mpp")
id("dev.suresh.plugin.publishing")
application
}
kotlin {
jvmTarget(project)
jsTarget(project)
wasmJsTarget(project)
wasmWasiTarget(project)
nativeTargets(project) {}
}
```
- Use the version catalog by copying [gradle/libs.versions.toml](gradle/libs.versions.toml) and change the
project-related metadata like `group`, `app-mainclass` etc.
> [!IMPORTANT]
> **Don't change** the existing version names in the catalog as it's being referenced in the plugins.
## Verifying Artifacts
The published artifacts are signed using this [key][signing_key]. The best way to verify artifacts
is [automatically with Gradle][gradle_verification].
[gradle_verification]: https://docs.gradle.org/current/userguide/dependency_verification.html#sec:signature-verification
[signing_key]: https://keyserver.ubuntu.com/pks/lookup?op=get&search=0xc124db3a8ad1c13f7153decdf209c085c8b53ca1
Misc
### Maven Central Publishing
```bash
# Publish to local maven repository
$ rm -rf ~/.m2/repository/dev/suresh
$ ./gradlew publishToMavenLocal
$ tree ~/.m2/repository/dev/suresh
# Publish the plugins to maven central
$ ./gradlew publishPluginMavenPublicationToMavenCentralRepository
# Publish the catalog to maven central
$ ./gradlew :catalog:publishToMavenCentral
$ ./gradlew :catalog:publishAndReleaseToMavenCentral
```
### Misc
```bash
# Update the Gradle Daemon JVM
$ ./gradlew updateDaemonJvm --jvm-version=21 --jvm-vendor=adoptium
```
## References
- [Kotlin DSL Plugin](https://docs.gradle.org/current/userguide/kotlin_dsl.html#sec:kotlin-dsl_plugin)
- [Pre-compiled Script Plugins](https://docs.gradle.org/current/userguide/implementing_gradle_plugins_precompiled.html#sec:applying_external_plugins)
[java_url]: https://www.azul.com/downloads/?version=java-21-lts&package=jdk#zulu
[java_img]: https://img.shields.io/badge/OpenJDK-21-e76f00?logo=openjdk&logoColor=e76f00
[kt_url]: https://github.com/JetBrains/kotlin/releases/latest
[kt_img]: https://img.shields.io/github/v/release/Jetbrains/kotlin?include_prereleases&color=7f53ff&label=Kotlin&logo=kotlin&logoColor=7f53ff
[maven_img]: https://img.shields.io/maven-central/v/dev.suresh.build/project?logo=gradle&logoColor=white&color=00B4E6
[maven_url]: https://central.sonatype.com/search?namespace=dev.suresh.build
[maven_dl]: https://search.maven.org/remote_content?g=dev.suresh.build&a=plugins&v=LATEST
[plugins_url]: https://repo.maven.apache.org/maven2/dev/suresh/plugin
[gha_url]: https://github.com/sureshg/build-commons/actions/workflows/build.yml
[gha_badge]: https://img.shields.io/github/actions/workflow/status/sureshg/build-commons/build.yml?branch=main&color=green&label=Build&logo=Github-Actions&logoColor=green
[sty_url]: https://kotlinlang.org/docs/coding-conventions.html
[sty_img]: https://img.shields.io/badge/style-Kotlin--Official-40c4ff.svg?style=for-the-badge&logo=kotlin&logoColor=40c4ff