7.2.0 (#221)

* Added new plugin for a more convenient installation of the library. * Moved from `ChainStateManager` to `StatefulLink` flow, since it's more convenient.
vendelieu · Aug 20, 2024 · cc99622 · cc99622
1 parent 2944f81
commit cc99622
Show file tree

Hide file tree

Showing 55 changed files with 900 additions and 589 deletions.
diff --git a/.github/workflows/ci.build.yml b/.github/workflows/ci.build.yml
@@ -4,7 +4,39 @@ on:
   push:
     branches:
       - master
+    paths-ignore:
+      - '.editorconfig'
+      - '.gitignore'
+      - 'CHANGELOG.md'
+      - 'CODE_OF_CONDUCT.md'
+      - 'CONTRIBUTING.md'
+      - 'FUNDING.yml'
+      - 'LICENSE'
+      - 'README.md'
+      - 'SECURITY.md'
+      - 'gradlew'
+      - 'gradlew.bat'
+      - 'parse_changelog.sh'
+      - 'renovate.json'
+      - '.github/**'
+      - 'assets/**'
   pull_request:
+    paths-ignore:
+      - '.editorconfig'
+      - '.gitignore'
+      - 'CHANGELOG.md'
+      - 'CODE_OF_CONDUCT.md'
+      - 'CONTRIBUTING.md'
+      - 'FUNDING.yml'
+      - 'LICENSE'
+      - 'README.md'
+      - 'SECURITY.md'
+      - 'gradlew'
+      - 'gradlew.bat'
+      - 'parse_changelog.sh'
+      - 'renovate.json'
+      - '.github/**'
+      - 'assets/**'
 
 permissions:
   contents: write
@@ -22,11 +54,19 @@ jobs:
           java-version: 17
 
       - name: Setup Gradle
-        uses: gradle/actions/setup-gradle@v3-beta
+        uses: gradle/actions/setup-gradle@v4
         with:
           gradle-version: current
           dependency-graph: generate-and-submit
 
+      - name: Cache konan dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.konan
+          key: ${{ runner.os }}-gradle-${{ hashFiles('*.gradle.kts') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle-
+
       - name: Build artifact
         env:
           TELEGRAM_ID: ${{ secrets.TELEGRAM_ID }}
@@ -35,7 +75,7 @@ jobs:
           BOT_TOKEN: ${{ secrets.BOT_TOKEN }}
           BOT_TOKEN_2: ${{ secrets.BOT_TOKEN_2 }}
           CHANNEL_ID: ${{ secrets.CHANNEL_ID }}
-        run: ./gradlew clean koverXmlReport
+        run: ./gradlew koverXmlReport
 
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v4

diff --git a/.github/workflows/ci.gh.snap.yml b/.github/workflows/ci.gh.snap.yml
@@ -3,6 +3,7 @@ name: GH Packages Autorelease
 on:
   push:
     paths:
+      - 'buildSrc/**'
       - 'helper/**'
       - 'telegram-bot/**'
       - 'ksp/**'
@@ -17,7 +18,20 @@ on:
 jobs:
   publish:
     runs-on: ubuntu-latest
-    if: github.event_name == 'push' && github.ref_type == 'branch'
+    if: github.event_name == 'push' && github.ref_type == 'branch' && !startsWith(github.ref, 'refs/heads/renovate/')
+    strategy:
+      matrix:
+        module: [
+          ":telegram-bot",
+          ":ksp",
+          ":webapps",
+          ":ktgram-utils",
+          ":ktgram-botctx-redis",
+          ":ktgram-config-env",
+          ":ktgram-config-toml",
+          ":ktor-starter",
+          ":spring-ktgram-starter"
+        ]
     steps:
       - uses: actions/checkout@v4
 
@@ -40,7 +54,15 @@ jobs:
         with:
           gradle-version: current
 
+      - name: Cache konan dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.konan
+          key: ${{ runner.os }}-gradle-${{ hashFiles('*.gradle.kts') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle-
+
       - name: Publish to Gh
         env:
           GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }}
-        run: ./gradlew publishAllPublicationsToGHPackagesRepository -PlibVersion=${{ env.git_branch }}-${{ env.date }}~${{ env.git_hash }}
+        run: ./gradlew ${{ matrix.module }}:publishAllPublicationsToGHPackagesRepository -PlibVersion=${{ env.git_branch }}-${{ env.date }}~${{ env.git_hash }}  --no-parallel
diff --git a/.github/workflows/ci.release.yml b/.github/workflows/ci.release.yml
@@ -34,10 +34,18 @@ jobs:
           java-version: 17
 
       - name: Setup gradle
-        uses: gradle/actions/setup-gradle@v3-beta
+        uses: gradle/actions/setup-gradle@v4
         with:
           gradle-version: current
 
+      - name: Cache konan dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.konan
+          key: ${{ runner.os }}-gradle-${{ hashFiles('*.gradle.kts') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle-
+
       - name: Prepare to publish
         run: |
           echo '${{secrets.GPG_KEY_CONTENTS}}' | base64 -d > publish_key.gpg
@@ -56,8 +64,13 @@ jobs:
           BRANCH: gh-pages
           FOLDER: telegram-bot/build/dokka
 
+      - run: ./gradlew publishPlugins -PlibVersion=${{ needs.version.outputs.version }}
+        env:
+          GRADLE_PUBLISH_KEY: ${{ secrets.GRADLE_PUBLISH_KEY }}
+          GRADLE_PUBLISH_SECRET: ${{ secrets.GRADLE_PUBLISH_SECRET }}
+
   readme:
-    needs: publish
+    needs: [ version, publish ]
     name: Replace version in README.md
     runs-on: ubuntu-latest
     permissions:
@@ -68,8 +81,8 @@ jobs:
           ref: ${{ github.head_ref }}
       - uses: jacobtomlinson/gha-find-replace@v3
         with:
-          find: '[0-9]+.[0-9]+.[0-9]+\"\)'
-          replace: "${{ needs.version.outputs.version }}\")"
+          find: '[:"]([0-9]+\.[0-9]+\.[0-9]+)\"'
+          replace: "${{ needs.version.outputs.version }}"
           include: "**README.md"
       - name: Push changes
         uses: stefanzweifel/git-auto-commit-action@v5

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Telegram-bot (KtGram) changelog
 
+## 7.2.0
+
+* Added new plugin for a more convenient installation of the library.
+* Moved from `ChainStateManager` to `StatefulLink` flow, since it's more convenient.
+
 ## 7.1.0
 
 * Cover Telegram API [7.9](https://core.telegram.org/bots/api#august-14-2024) version.

diff --git a/README.md b/README.md
@@ -13,10 +13,22 @@ Telegram Bot Api wrapper with a user-friendly interface.
 
 # Installation
 
-Add the ksp plugin and library to the dependencies.
+Add the ksp plugin and library plugin to your Gradle build file.
 
 build.gradle.kts example:
 
+```gradle
+plugins {
+    // ...
+    id("com.google.devtools.ksp") version "2.0.10-1.0.24"
+    id("eu.vendeli.telegram-bot") version "7.1.0"
+}
+```
+
+<details>
+<summary>Manually</summary>
+To set up the project without using the plugin, you need to add a dependency and configure the ksp processor:
+
 ```gradle
 plugins {
     // ...
@@ -30,12 +42,27 @@ dependencies {
 }
 ```
 
+For multiplatform, you need to add the dependency to common sources and define ksp for the targets you need, see example
+in [native-example](https://github.com/ktgram/native-example/blob/master/build.gradle.kts).
+</details>
+
+
 <details>
   <summary><i>Snapshots</i></summary>
 
 [![Snapshot version](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fv229149.hosted-by-vdsina.ru%2Fsnap-ver%2Ftelegram-bot&query=%24%5B0%5D.name&logo=github&label=SNAPSHOT&link=https%3A%2F%2Fgithub.com%2Fvendelieu%3Ftab%3Dpackages%26repo_name%3Dtelegram-bot)](https://github.com/vendelieu?tab=packages&repo_name=telegram-bot)
 
-To install snapshot versions add dev repository:
+To install snapshot versions, add snapshot repository,
+if you're using plugin just use `addSnapshotRepo` parameter:
+
+```gradle
+ktGram {
+    forceVersion = "branch-xxxxxx~xxxxxx"
+    addSnapshotRepo = true
+}
+```
+
+or manually add repository:
 
 ```gradle
 repositories {
@@ -45,8 +72,8 @@ repositories {
 }
 ```
 
-And use the latest package version from [packages](https://github.com/vendelieu?tab=packages&repo_name=telegram-bot) or
-from badge above.
+And add library dependency (with ksp processor) as described in `manually` section using the latest package version
+from [packages](https://github.com/vendelieu?tab=packages&repo_name=telegram-bot) or from badge above.
 
 </details>
 
@@ -128,20 +155,23 @@ fun main() = runBlocking {
 
 ### Configuration
 
-The library has very flexible customization options, \, 
+The library has very flexible customization options, \,
 and there are different options to configure through external sources.
 
 You can read more in a [Bot configuration](https://github.com/vendelieu/telegram-bot/wiki/Bot-configuration) article.
 
 ### Processing responses
 
 To process over response or/and have more control over request flow
-use [`sendReturning()`](https://vendelieu.github.io/telegram-bot/-telegram%20-bot/eu.vendeli.tgbot.interfaces/-action/send-returning.html)
+use [
+`sendReturning()`](https://vendelieu.github.io/telegram-bot/-telegram%20-bot/eu.vendeli.tgbot.interfaces.action/-action/send-returning.html)
 instead
-of [`send()`](https://vendelieu.github.io/telegram-bot/-telegram%20-bot/eu.vendeli.tgbot.interfaces/-action/send.html)
+of [
+`send()`](https://vendelieu.github.io/telegram-bot/-telegram%20-bot/eu.vendeli.tgbot.interfaces.action/-action/send.html)
 method,
 which
-returns [`Response`](https://vendelieu.github.io/telegram-bot/-telegram%20-bot/eu.vendeli.tgbot.types.internal/-response/index.html):
+returns [
+`Response`](https://vendelieu.github.io/telegram-bot/-telegram%20-bot/eu.vendeli.tgbot.types.internal/-response/index.html):
 
 ```kotlin
 message { "test" }.sendReturning(user, bot).onFailure {
@@ -150,11 +180,15 @@ message { "test" }.sendReturning(user, bot).onFailure {
 ```
 
 Any `sendReturning` method returns
-a [`Response`](https://vendelieu.github.io/telegram-bot/-telegram%20-bot/eu.vendeli.tgbot.types.internal/-response/index.html)
+a [
+`Response`](https://vendelieu.github.io/telegram-bot/-telegram%20-bot/eu.vendeli.tgbot.types.internal/-response/index.html)
 on which you can also use
-methods [`getOrNull()`](https://vendelieu.github.io/telegram-bot/-telegram%20-bot/eu.vendeli.tgbot.types.internal/get-or-null.html)
-, [`isSuccess()`](https://vendelieu.github.io/telegram-bot/-telegram%20-bot/eu.vendeli.tgbot.types.internal/is-success.html)
-, [`onFailure()`](https://vendelieu.github.io/telegram-bot/-telegram%20-bot/eu.vendeli.tgbot.types.internal/on-failure.html)
+methods [
+`getOrNull()`](https://vendelieu.github.io/telegram-bot/-telegram%20-bot/eu.vendeli.tgbot.types.internal/get-or-null.html)
+, [
+`isSuccess()`](https://vendelieu.github.io/telegram-bot/-telegram%20-bot/eu.vendeli.tgbot.types.internal/is-success.html)
+, [
+`onFailure()`](https://vendelieu.github.io/telegram-bot/-telegram%20-bot/eu.vendeli.tgbot.types.internal/on-failure.html)
 
 ### Additional resources
 

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -13,9 +13,9 @@ plugins {
 }
 
 tasks.create("prepareRelease") {
-    dependsOn("ksp:formatKotlin")
     dependsOn("telegram-bot:kdocUpdate")
     dependsOn("telegram-bot:formatKotlin")
+    dependsOn("ktgram-gradle-plugin:formatKotlin")
     dependsOn("helper:formatKotlin")
 
     dependsOn("ksp:detekt")

diff --git a/buildSrc/src/main/kotlin/publish.gradle.kts b/buildSrc/src/main/kotlin/publish.gradle.kts
@@ -1,27 +1,30 @@
 import com.vanniktech.maven.publish.JavadocJar
+import com.vanniktech.maven.publish.KotlinJvm
 import com.vanniktech.maven.publish.KotlinMultiplatform
 import com.vanniktech.maven.publish.SonatypeHost
 
 plugins {
     id("com.vanniktech.maven.publish")
 }
 
-apply(plugin = "org.jetbrains.kotlin.multiplatform")
 val libraryData = extensions.create("libraryData", PublishingExtension::class)
-val doSign = providers.gradleProperty("signing.keyId").isPresent
+val releaseMode = providers.gradleProperty("signing.keyId").isPresent
+val isMultiplatform = !project.plugins.hasPlugin("org.jetbrains.kotlin.jvm")
+
+if (isMultiplatform) apply(plugin = "org.jetbrains.kotlin.multiplatform")
 
 mavenPublishing {
     coordinates("eu.vendeli", project.name, project.version.toString())
     publishToMavenCentral(SonatypeHost.CENTRAL_PORTAL, true)
-    if (doSign) signAllPublications()
+    if (releaseMode) signAllPublications()
+
+    val javaDoc = if (project.name == "telegram-bot" && releaseMode) JavadocJar.Dokka("dokkaHtml")
+    else JavadocJar.Empty()
+
+    val platformArtifact = if (isMultiplatform) KotlinMultiplatform(javaDoc, true)
+    else KotlinJvm(JavadocJar.None(), true)
 
-    configure(
-        KotlinMultiplatform(
-            javadocJar = if (project.name == "telegram-bot" && doSign) JavadocJar.Dokka("dokkaHtml")
-            else JavadocJar.Empty(),
-            sourcesJar = true,
-        ),
-    )
+    configure(platformArtifact)
 
     pom {
         name = libraryData.name

diff --git a/gradle.properties b/gradle.properties
@@ -1,3 +1,6 @@
-org.gradle.jvmargs=-Xmx4096M -XX:MaxMetaspaceSize=1024m
+org.gradle.jvmargs=-Xmx1g -XX:MaxMetaspaceSize=1g -Dfile.encoding=UTF-8
 org.gradle.parallel=true
+org.gradle.caching=true
+org.gradle.configuration-cache-problems=warn
+org.gradle.configuration-cache=true
 kotlin.incremental=true
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -2,7 +2,7 @@
 ktor = "2.3.12"
 redis = "6.4.0.RELEASE"
 logging = "2.0.4"
-logback = "1.5.6"
+logback = "1.5.7"
 
 datetime = "0.6.0"
 serialization = "1.7.1"
@@ -27,6 +27,7 @@ poet = "1.18.1"
 
 binvalid = "0.16.3"
 publisher = "0.29.0"
+gradle-publish = "1.2.1"
 env = "1.0.4"
 
 [libraries]
@@ -62,6 +63,7 @@ ksp = { module = "com.google.devtools.ksp:symbol-processing-api", version.ref =
 poet = { module = "com.squareup:kotlinpoet", version.ref = "poet" }
 poet-ksp = { module = "com.squareup:kotlinpoet-ksp", version.ref = "poet" }
 mockk = { module = "io.mockk:mockk", version.ref = "mockk" }
+ksp-plugin = { module = "com.google.devtools.ksp:com.google.devtools.ksp.gradle.plugin", version.ref = "ksp" }
 
 ssl-utils = { module = "io.github.hakky54:sslcontext-kickstart-for-pem", version.ref = "sslcontext" }
 spring-starter = { module = "org.springframework.boot:spring-boot-starter", version.ref = "spring" }
@@ -71,12 +73,11 @@ redis = { module = "io.lettuce:lettuce-core", version.ref = "redis" }
 env = { module = "dev.scottpierce:kotlin-env-var", version.ref = "env" }
 toml = { module = "net.peanuuutz.tomlkt:tomlkt", version.ref = "toml" }
 
-
 [plugins]
-kotlin-multiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }
 kotlin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }
 kotlin-js-plain-objects = { id = "org.jetbrains.kotlin.plugin.js-plain-objects", version.ref = "kotlin" }
 kotlin-compatability-validator = { id = "org.jetbrains.kotlinx.binary-compatibility-validator", version.ref = "binvalid" }
+gradle-publish = { id = "com.gradle.plugin-publish", version.ref = "gradle-publish"}
 ksp = { id = "com.google.devtools.ksp", version.ref = "ksp" }
 dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }
 kover = { id = "org.jetbrains.kotlinx.kover", version.ref = "kover" }