ci: configure snapshot release

Author: Flaxoos

RELEASING.md

@@ -5,11 +5,11 @@ This document explains how to create releases for the extra-ktor-plugins project
 ## Quick Start - How to Release
 
 ### 🔄 Automatic Snapshots
-**No action needed!** Snapshots are created automatically:
+**No action needed!** Snapshots are built and staged locally:
 - Push commits to `main` branch
 - Wait for `build-main.yml` to succeed
 - `release.yml` automatically triggers and creates a snapshot (e.g., `2.3.0-SNAPSHOT`)
-- Artifacts published to Maven Central staging repository
+- Artifacts are staged locally but **not published to Maven Central**
 
 ### 🚀 Production Release
 1. Go to **Actions** tab in GitHub
@@ -26,6 +26,16 @@ This document explains how to create releases for the extra-ktor-plugins project
 ### 📦 Manual Snapshot (Optional)
 Same as production release, but select **"snapshot"** from the dropdown.
 
+### Snapshot vs Release Details
+
+The `release.yml` workflow decides whether to perform a snapshot or a release based on the type of trigger and the `release.mode` property:
+
+- **Automatic triggers** (e.g., after successful `build-main.yml`) default to `release.mode=snapshot`, producing snapshot versions.
+- **Manual triggers** allow selection between `snapshot` and `release` modes.
+- The `release.mode` property controls version suffixes and deployment behavior:
+    - `snapshot` mode appends `-SNAPSHOT` and stages artifacts locally without publishing to Maven Central.
+    - `release` mode produces clean versions and publishes artifacts to Maven Central with GitHub release creation.
+
 ---
 
 ## How It Works
@@ -101,6 +111,7 @@ snapshotCreator { version, position ->
 - Publishes to Maven Central staging repository
 - No GitHub release created
 - No tags created
+- Snapshots are released to ossrh repository (maven central doesn't support snapshots)
 
 **Release Mode (`jreleaserFullRelease`):**
 - Publishes to Maven Central (production)
@@ -109,6 +120,19 @@ snapshotCreator { version, position ->
 
 **Configuration:** Located in `build.gradle.kts` under `jreleaser` block
 
+##### Snapshot Publishing (optional)
+
+To enable snapshot publishing with JReleaser, you can add a snapshot deployer in Gradle configuration:
+
+```kotlin
+jreleaser {
+    snapshot {
+        active = org.jreleaser.model.Active.SNAPSHOT
+        // configure snapshot deployer details here
+    }
+}
+```
+
 #### 4. **Build Main Workflow** (`.github/workflows/build-main.yml`)
 **Role:** Quality gate for automatic snapshots
 
@@ -155,7 +179,7 @@ snapshotCreator { version, position ->
 
 ### Conventional Commits Integration
 
-The system relies on conventional commit messages for version calculation:
+The system relies on conventional commit messages for version calculation and now includes merge commits in the changelog generation using the settings `skipMergeCommits=false` and `includeUncategorized=true`. Non-conventional commit subjects such as merge commits will appear under the "Uncategorized" section of the changelog, while CI-related commits are filtered out to keep the changelog relevant and clean.
 
 | Commit Type | Version Impact | Example |
 |-------------|----------------|---------|

build.gradle.kts

@@ -12,6 +12,10 @@ import org.gradle.api.tasks.testing.logging.TestLogEvent.SKIPPED
 import org.gradle.api.tasks.testing.logging.TestLogging
 import org.gradle.api.tasks.testing.logging.TestStackTraceFilter
 import org.jreleaser.gradle.plugin.dsl.deploy.maven.MavenCentralMavenDeployer
+import org.jreleaser.gradle.plugin.dsl.deploy.maven.Nexus2MavenDeployer
+import org.jreleaser.model.Active.ALWAYS
+import org.jreleaser.model.Active.RELEASE
+import org.jreleaser.model.Active.SNAPSHOT
 import ru.vyarus.gradle.plugin.python.PythonExtension
 import java.time.Instant.ofEpochSecond
 
@@ -163,10 +167,12 @@ scmVersion {
                         hasMajor = true
                         logger.quiet("[VersionIncrementer]   → Triggers MAJOR version bump (breaking change)")
                     }
+
                     type == "feat" -> {
                         hasMinor = true
                         logger.quiet("[VersionIncrementer]   → Triggers MINOR version bump (new feature)")
                     }
+
                     type in
                         setOf(
                             "fix",
@@ -244,61 +250,78 @@ allprojects {
     version = rootProject.version
 }
 
+// see: https://jreleaser.org/guide/latest/examples/maven/maven-central.html#_portal_publisher_api
 jreleaser {
     // Configure the project
     project {
-        name.set("${rootProject.name}: ${project.name}")
-        description.set(
-            "This project provides a suite of feature-rich, efficient, and highly customizable plugins for your Ktor Server or Client, crafted in Kotlin, available for multiplatform.",
-        )
-        longDescription.set(
-            "A comprehensive collection of Ktor plugins including rate limiting, Kafka integration, circuit breaker patterns, and distributed task scheduling. Built with Kotlin Multiplatform support for JVM, Native, and JS platforms.",
-        )
-        authors.add("Ido Flax")
-        license.set("Apache-2.0")
-        copyright.set("Copyright (c) 2023 Ido Flax")
+        name = "${rootProject.name}: ${project.name}"
+        description =
+            "This project provides a suite of feature-rich, efficient, and highly customizable plugins for your Ktor Server or Client, crafted in Kotlin, available for multiplatform."
+
+        longDescription =
+            "A comprehensive collection of Ktor plugins including rate limiting, Kafka integration, circuit breaker patterns, and distributed task scheduling. Built with Kotlin Multiplatform support for JVM, Native, and JS platforms."
+
+        license = "Apache-2.0"
+        copyright = "Copyright (c) 2023 Ido Flax"
         authors.add("Ido Flax")
         maintainers.add("Ido Flax")
         links {
-            homepage.set("https://github.com/Flaxoos/extra-ktor-plugins")
-            documentation.set("https://flaxoos.github.io/extra-ktor-plugins/")
-            license.set("https://opensource.org/license/apache-2-0")
-            donation.set("https://github.com/sponsors/Flaxoos")
-            contact.set("Kotlin Slack - Ido Flax. [email protected]")
+            homepage = "https://github.com/Flaxoos/extra-ktor-plugins"
+            documentation = "https://flaxoos.github.io/extra-ktor-plugins/"
+            license = "https://opensource.org/license/apache-2-0"
+            donation = "https://github.com/sponsors/Flaxoos"
+            contact = "Kotlin Slack - Ido Flax. [email protected]"
         }
-        inceptionYear.set("2023")
+        inceptionYear = "2023"
     }
     // Sign the release
     signing {
-        active.set(org.jreleaser.model.Active.ALWAYS)
-        armored.set(true)
-        publicKey.set(jreleaserGpgPublicKey)
-        secretKey.set(jreleaserGpgSecretKey)
-        passphrase.set(jreleaserGpgPassphrase)
+        active = ALWAYS
+        armored = true
+        publicKey = jreleaserGpgPublicKey
+        secretKey = jreleaserGpgSecretKey
+        passphrase = jreleaserGpgPassphrase
     }
-    // Deploy to Maven Central
     deploy {
+        val stagingDir =
+            layout.buildDirectory
+                .dir("staging-deploy")
+                .get()
+                .asFile
+        if (!stagingDir.exists()) stagingDir.mkdirs()
         maven {
             mavenCentral {
                 create(
-                    "flaxoos-extra-ktor-plugins",
+                    "release-deploy",
                     closureOf<MavenCentralMavenDeployer> {
-                        active.set(org.jreleaser.model.Active.ALWAYS)
-                        url.set("https://central.sonatype.com/api/v1/publisher")
-                        stagingRepository(
-                            layout.buildDirectory
-                                .dir("staging-deploy")
-                                .get()
-                                .asFile.absolutePath,
-                        )
+                        active = RELEASE
+                        url = "https://central.sonatype.com/api/v1/publisher"
+                        stagingRepository(stagingDir.absolutePath)
 
-                        username.set(mcUsername)
-                        password.set(mcPassword)
+                        username = mcUsername
+                        password = mcPassword
 
-                        connectTimeout.set(20)
-                        readTimeout.set(60)
-                        retryDelay.set(5)
-                        maxRetries.set(3)
+                        connectTimeout = 20
+                        readTimeout = 60
+                        retryDelay = 5
+                        maxRetries = 3
+                    },
+                )
+            }
+            nexus2 {
+                create(
+                    "snapshot-deploy",
+                    closureOf<Nexus2MavenDeployer> {
+                        active = SNAPSHOT
+                        snapshotUrl = "https://central.sonatype.com/repository/maven-snapshots/"
+                        applyMavenCentralRules = true
+                        snapshotSupported = true
+                        closeRepository = true
+                        releaseRepository = true
+                        stagingRepository(stagingDir.absolutePath)
+
+                        username = mcUsername
+                        password = mcPassword
                     },
                 )
             }
@@ -307,14 +330,14 @@ jreleaser {
     // Create a release in GitHub
     release {
         github {
-            enabled.set(true)
-            repoOwner.set("Flaxoos")
-            name.set("extra-ktor-plugins")
-            tagName.set("v{{projectVersion}}")
-            releaseName.set("v{{projectVersion}}")
-            overwrite.set(true)
+            enabled = true
+            repoOwner = "Flaxoos"
+            name = "extra-ktor-plugins"
+            tagName = "v{{projectVersion}}"
+            releaseName = "v{{projectVersion}}"
+            overwrite = true
             update {
-                enabled.set(true)
+                enabled = true
             }
             changelog {
                 enabled.set(true)

buildSrc/src/main/kotlin/io/github/flaxoos/ktor/extensions/Credentials.kt

@@ -17,7 +17,8 @@ val Project.gprUser: String by ProjectPropertyDelegate.projectOrSystemEnv()
 
 val Project.mcUsername: String by ProjectPropertyDelegate.projectOrSystemEnv()
 val Project.mcPassword: String by ProjectPropertyDelegate.projectOrSystemEnv()
-
+val Project.ossrhUsername: String by ProjectPropertyDelegate.projectOrSystemEnv()
+val Project.ossrhPassword: String by ProjectPropertyDelegate.projectOrSystemEnv()
 val Project.jreleaserGpgPublicKey: String by ProjectPropertyDelegate.projectOrSystemEnv()
 val Project.jreleaserGpgSecretKey: String by ProjectPropertyDelegate.projectOrSystemEnv()
 val Project.jreleaserGpgPassphrase: String by ProjectPropertyDelegate.projectOrSystemEnv()