Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update 2.1.0 internal compiler APIs doc #4631

Merged
merged 6 commits into from
Jan 21, 2025
Merged

Update 2.1.0 internal compiler APIs doc #4631

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b8f8ccd
Update 2.1.0 internal compiler APIs doc
martinbonnin Jan 3, 2025
6fa7c32
Cosmetics
martinbonnin Jan 3, 2025
426093d
Update whatsnew21.md
martinbonnin Jan 3, 2025
69f3313
Update whatsnew21.md
martinbonnin Jan 3, 2025
8e4e034
update: update whatsnew21.md
koshachy Jan 21, 2025
0f8391e
chore: update whatsnew21.md
koshachy Jan 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 14 additions & 10 deletions docs/topics/whatsnew21.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1249,16 +1249,20 @@ You can use the `KotlinAndroidExtension` in exactly the same way.

### Compiler symbols hidden from the Kotlin Gradle plugin API

Starting with Kotlin 2.1.0,
you will receive a warning if you access compiler module symbols bundled within the Kotlin Gradle plugin (KGP).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this was technically not exact, right? The warning is based on the presence of a class file that is not bundled in KGP but build logic could still use the symbols bundled with KGP without being detected?

Previously, the KGP included `org.jetbrains.kotlin:kotlin-compiler-embeddable` in its runtime dependencies,
making internal compiler symbols, such as `KotlinCompilerVersion`, available in the build script classpath.
Previously, KGP included `org.jetbrains.kotlin:kotlin-compiler-embeddable` in its runtime dependencies,
making internal compiler symbols available in the build script classpath.
These symbols were intended for internal use only.

These symbols are intended for internal use only.
Access to them will be removed in upcoming Kotlin releases to prevent compatibility issues and simplify KGP maintenance.
If your build logic relies on any compiler symbols,
you need to update it and use the [Gradle Workers API](https://docs.gradle.org/current/userguide/worker_api.html)
with classloader or process isolation to ensure safe interaction with the compiler.
Starting with Kotlin 2.1.0, KGP bundles a subset of `org.jetbrains.kotlin:kotlin-compiler-embeddable` class files in its JAR file and progressively removes them.
This change aims to prevent compatibility issues and simplify KGP maintenance.

If other parts of your build logic, such as plugins like `kotlinter`, depend on a different version of `org.jetbrains.kotlin:kotlin-compiler-embeddable`
than the one bundled with KGP, it can lead to conflicts and runtime exceptions.

To prevent such issues, KGP now shows a warning if `org.jetbrains.kotlin:kotlin-compiler-embeddable` is present in the build classpath alongside KGP.

As a long-term solution, if you're a plugin author using `org.jetbrains.kotlin:kotlin-compiler-embeddable` classes, we recommend running them in an isolated classloader.
For example, you can achieve it using the [Gradle Workers API](https://docs.gradle.org/current/userguide/worker_api.html) with classloader or process isolation.

#### Using the Gradle Workers API

Expand Down Expand Up @@ -1597,4 +1601,4 @@ Starting from IntelliJ IDEA 2023.3 and Android Studio Iguana (2023.2.1) Canary 1
bundled plugin included in your IDE. This means that you can't install the plugin from JetBrains Marketplace anymore.

To update to the new Kotlin version, [change the Kotlin version](releases.md#update-to-a-new-kotlin-version)
to 2.1.0 in your build scripts.
to 2.1.0 in your build scripts.
Loading