Merge branch 'main' of github.com:Kotlin/kotlinx-rpc into issue-226

# Conflicts:
#	krpc/krpc-server/src/commonMain/kotlin/kotlinx/rpc/krpc/server/KrpcServer.kt

Author: yakivy

.github/workflows/changelog.yml

@@ -0,0 +1,30 @@
+name: Verify Docs Changelog
+
+on:
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  verify-platforms-table:
+    name: Run Verification
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Sources
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
+
+      - name: Check Platforms Table
+        run: ./gradlew updateDocsChangelog --info --stacktrace
+
+      - name: Check if changelog is up-to-date
+        run: |
+          if [[ -n "$(git status --porcelain | grep docs/pages/kotlinx-rpc/topics/changelog.md)" ]]; then
+            echo "Changelog is not up to date. Please run './gradlew updateDocsChangelog' and commit changes"
+            exit 1
+          fi

.github/workflows/docs.yml

@@ -6,10 +6,20 @@ on:
       - 'docs/pages/**'
       - '.github/workflows/**'
   workflow_dispatch:
+    inputs:
+      build_id:
+        description: 'Id of TeamCity build that produced the Dokka artifact.'
+        required: true
+      dry_run:
+        type: boolean
+        description: "Dry run. If set to true, the action will not actually publish the pages, but will assemble the artifact."
+        default: true
+        required: true
 
 permissions:
   id-token: write
   pages: write
+  contents: read
 
 env:
   INSTANCE: 'kotlinx-rpc/rpc'
@@ -20,7 +30,10 @@ env:
   ALGOLIA_INDEX_NAME: 'prod_kotlin_rpc'
   ALGOLIA_KEY: '${{ secrets.ALGOLIA_KEY }}'
   CONFIG_JSON_PRODUCT: 'kotlinx-rpc'
-  CONFIG_JSON_VERSION: '0.5.1'
+  CONFIG_JSON_VERSION: '0.8.0'
+  DOKKA_ARTIFACT: 'dokka.zip'
+  ASSEMBLE_DIR: '__docs_assembled'
+  ASSEMBLE_ARTIFACT: 'assembled.zip'
 
 jobs:
   build:
@@ -64,45 +77,96 @@ jobs:
         with:
           instance: ${{ env.INSTANCE }}
 
-  deploy:
+  assemble:
     if: github.event_name == 'workflow_dispatch'
+    needs: [ build, test ]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Download Writerside artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: kotlinx-rpc
+
+      - name: Unzip Writerside artifacts
+        run: unzip -O UTF-8 -qq '${{ env.ARTIFACT }}' -d ${{ env.ASSEMBLE_DIR }}
+
+      - name: Download Dokka
+        run: |
+          if [ -z "${{ inputs.build_id }}" ]; then
+            echo "'build_id' is not set"
+            exit 1
+          fi
+          
+          echo "Downloading Dokka artifact, build id: ${{ inputs.build_id }}"
+
+          artifact_url="https://krpc.teamcity.com/app/rest/builds/id:${{ inputs.build_id }}/artifacts/content/${{ env.DOKKA_ARTIFACT }}"
+          echo "Downloading Dokka artifact from URL: $artifact_url"
+
+          curl -v -s -f -L -H "Authorization: Bearer ${{ secrets.TEAMCITY_TOKEN }}" "$artifact_url" -o "${{ env.DOKKA_ARTIFACT }}"
+          
+          if [ -z "$(ls | grep -x ${{ env.DOKKA_ARTIFACT }})" ]; then
+            echo "Failed to download Dokka artifact, asset id: ${{ inputs.build_id }}"
+            exit 1
+          fi
+
+      - name: Unzip Dokka
+        run: unzip -O UTF-8 -qq '${{ env.DOKKA_ARTIFACT }}' -d ${{ env.ASSEMBLE_DIR }}/api
+
+      - name: Update sitemap.xml
+        run: chmod +x updateSitemap.sh && ./updateSitemap.sh ${{ env.ASSEMBLE_DIR }}/sitemap.xml ${{ env.ASSEMBLE_DIR }}/api
+
+      - name: Save assembled artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: kotlinx-rpc-assembled
+          path: |
+            ${{ env.ASSEMBLE_DIR }}
+          retention-days: 7
+
+  deploy:
+    if: github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main' && !inputs.dry_run
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
-    needs: [ build, test ]
+    needs: [ build, test, assemble ]
     runs-on: ubuntu-latest
     steps:
       - name: Download artifacts
         uses: actions/download-artifact@v4
         with:
-          name: kotlinx-rpc
+          name: kotlinx-rpc-assembled
 
       - name: Unzip artifact
-        run: unzip -O UTF-8 -qq '${{ env.ARTIFACT }}' -d dir
+        run: unzip -O UTF-8 -qq '${{ env.ASSEMBLE_ARTIFACT }}' -d ${{ env.ASSEMBLE_DIR }}
 
       - name: Setup Pages
         uses: actions/configure-pages@v5
 
       - name: Package and upload Pages artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: dir
+          path: ${{ env.ASSEMBLE_DIR }}
 
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4
 
   publish-indexes:
-    if: github.event_name == 'workflow_dispatch'
-    needs: [ build, test, deploy ]
+    if: github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main' && !inputs.dry_run
+    needs: [ build, test, assemble, deploy ]
     runs-on: ubuntu-latest
     container:
       image: registry.jetbrains.team/p/writerside/builder/algolia-publisher:2.0.32-3
     steps:
       - name: Download artifact
         uses: actions/download-artifact@v4
         with:
-          name: kotlinx-rpc
+          name: kotlinx-rpc-assembled
       - name: Unzip artifact
         run: |
           unzip -O UTF-8 -qq '${{ env.ALGOLIA_ARTIFACT }}' -d algolia-indexes

.github/workflows/platforms.yml

@@ -0,0 +1,21 @@
+name: Verify Platforms Table
+
+on:
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  verify-platforms-table:
+    name: Run Verification
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Sources
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
+      - name: Check Platforms Table
+        run: ./gradlew verifyPlatformTable --no-configuration-cache --info --stacktrace

.gitignore

@@ -19,6 +19,7 @@ lib-kotlin
 !.idea/icon.svg
 !.idea/detekt.xml
 !.idea/kotlinTestDataPluginTestDataPaths.xml
+!.idea/kotlinx-rpc.iml
 
 samples/**/.idea/*
 

.idea/kotlinx-rpc.iml

@@ -1,8 +1,13 @@
+/*
+ * Copyright 2023-2025 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+ */
+
 const {join} = require('path');
 
-const isCI = process.env.TEAMCITY_VERSION
+const isTC = process.env.TEAMCITY_VERSION;
+const isGA = process.env.GITHUB_ACTIONS;
 
-if (isCI) {
+if (isTC !== undefined || isGA !== undefined) {
     /**
      * @type {import("puppeteer").Configuration}
      */

.puppeteerrc.cjs

@@ -1,3 +1,118 @@
+# 0.8.0
+> Published 30 June 2025
+
+## Overview
+This release brings a lot of changes, including breaking changes:
+- Kotlin 2.2.0 Update
+- Decoupling of `kotlinx.serialization` from the core functionality
+- Simplifying lifetime schema (services lost their `CoroutineScope`)
+- Irreversible enforcement of the [strict mode](https://kotlin.github.io/kotlinx-rpc/strict-mode.html)
+
+These changes significantly reduce the number of footguns and improve the overall usability of the library.
+
+Additionally, the internal structure of kRPC protocol and our compiler plugin reduced its complexity. 
+That allows us to provide better quality in future releases
+(and this also applies to gRPC, even though in this particular release it was not a priority).
+
+For the full list of changes that require migration,
+see the [Migration Guide](https://kotlin.github.io/kotlinx-rpc/0-8-0.html).
+
+## Docs update
+
+We added three new documentation sections:
+- [API Reference](https://kotlin.github.io/kotlinx-rpc/api/index.html) 
+- [Platform compatibility overview](https://kotlin.github.io/kotlinx-rpc/platforms.html) 
+- [Changelog](https://kotlin.github.io/kotlinx-rpc/changelog.html) in the web
+
+### Features 🎉
+* Serialization decoupling by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/354
+* Update Kotlin to 2.2.0 by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/359
+
+### Breaking Changes 🔴
+* [Meta] Strict mode, deprecations, lifetime by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/353
+
+### Bug fixes 🐛
+* Fix compilation for standalone k2 module by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/350
+* Fix Pupperteer Version by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/355
+
+### Documentation 📗
+* Platforms Table and docs by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/356
+* Dokka  by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/357
+* Add Changelog.md to Docs by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/358
+* Onboarding by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/363
+
+### Other Changes 🧹
+* Advance version to 0.8.0-SNAPSHOT by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/340
+* Update README.md to use non-suspend flows by @brokenhappy in https://github.com/Kotlin/kotlinx-rpc/pull/342
+* Fix kotlin master builds by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/345
+* Simplify Gradle Configs by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/360
+
+## New Contributors
+* @brokenhappy made their first contribution in https://github.com/Kotlin/kotlinx-rpc/pull/342
+
+**Full Changelog**: https://github.com/Kotlin/kotlinx-rpc/compare/0.7.0...0.8.0
+
+# 0.7.0
+> Published 13 May 2025
+
+## Announcement
+This release enforces ERROR as a default reporting level for APIs that are forbidden by the strict mode.
+You can still change the level manually, but in `0.8.0` strict mode will be enforced irreversibly.
+
+### Breaking Changes 🔴
+* Change strict mode to level ERROR by default by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/338
+
+### Other Changes 🧹
+* Update Kotlin to 2.1.21 by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/337
+* Version 0.7.0-SNAPSHOT by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/325
+* Samples: version 0.6.2 by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/326
+* 2.2.0 compiler migration by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/335
+
+**Full Changelog**: https://github.com/Kotlin/kotlinx-rpc/compare/0.6.2...0.7.0
+
+# 0.6.2
+> Published 17 April 2025
+
+### Bug fixes 🐛
+* Fix flows that emit Units by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/323
+
+**Full Changelog**: https://github.com/Kotlin/kotlinx-rpc/compare/0.6.1...0.6.2
+
+# 0.6.1
+> Published 11 April 2025
+
+### Bug fixes 🐛
+* Fix bidirectional flows in non-suspend streams by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/316
+* Fix KRPC-173 (#315) by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/317
+
+**Full Changelog**: https://github.com/Kotlin/kotlinx-rpc/compare/0.6.0...0.6.1
+
+# 0.6.0
+> Published 4 April 2025
+
+### Features 🎉
+* 2.1.20 by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/309
+* Non suspend flow by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/299
+
+### Documentation 📗
+* Update gRPC Docs and Sample by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/284
+
+### Infra 🚧
+* Update monitior by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/282
+* Fix build config for for-ide builds by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/287
+* Update build for custom KC versions by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/293
+* Fix kotlin master compilation by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/306
+
+### Other Changes 🧹
+* Upgrade Gradle to 8.12.1 by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/286
+* Version 0.6.0-SNAPSHOT by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/283
+* Update leftover sources from jvm-only to kmp by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/300
+* KRPC-129 Move compatibility tests from Toolbox to Kotlin RPC repo by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/304
+* Dependency bump by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/303
+* Better compiler error message for checked annotations by @Mr3zee in https://github.com/Kotlin/kotlinx-rpc/pull/302
+
+**Full Changelog**: https://github.com/Kotlin/kotlinx-rpc/compare/0.5.1...0.6.0
+
 # 0.5.1
 > Published 12 February 2025
 

CHANGELOG.md

@@ -84,7 +84,6 @@ on how to work with the project.
 
 Contributions are made using Github [pull requests](https://help.github.com/en/articles/about-pull-requests):
 
-[//]: # (TODO change repo link to the repo)
 1. Fork the `kotlinx.rpc` repository and work on your fork.
 2. [Create](https://github.com/kotlin/kotlinx-rpc/compare) a new PR with a request to merge to the **main** branch. 
 3. Ensure that the description is clear and refers to an existing ticket/bug if applicable.