Migrate to `Reaction` API #47

alexander-yevsyukov · 2025-11-28T16:28:40Z

This PR migrates the Compiler to use Reaction API recently introduced in CoreJvm in addition to the "canonical" Pollicy. The PR updates the documentation and renames the properties accordingly.

Other notable changes

Applied latest documentation build changes from config.

Copilot

Pull request overview

This PR migrates the project to use the new Dokka 2.1.0 API with the Reaction system for generating documentation. The changes consolidate documentation generation setup and update dependency versions.

Migrates from Dokka 2.0.0 to 2.1.0 with updated plugin configuration
Consolidates Dokka setup into a single dokka-setup plugin
Updates various dependency versions (Protobuf, Gradle, Validation, etc.)

Reviewed changes

Copilot reviewed 43 out of 45 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
version.gradle.kts	Updates compiler version from 030 to 031
pom.xml	Updates Protobuf, Validation, and Dokka dependency versions
params/src/main/kotlin/.../CommandLineInterface.kt	Updates documentation reference to new format API
jvm/src/main/kotlin/.../ModifiedTypeAnnotation.kt	Updates documentation references from `Modified.date` to `Modified.timestamp`
gradlew.bat	Removes unused CLASSPATH environment variable
gradlew	Moves Protobuf version check export to top of file
gradle/wrapper/gradle-wrapper.properties	Updates Gradle wrapper from 9.1.0 to 9.2.1
gradle-plugin/.../PluginSpec.kt	Adds environment variable for Protobuf version check
dependencies.md	Updates dependency versions and generation timestamp
config	Updates subproject commit reference
buildSrc/.../module.gradle.kts	Consolidates dokka plugins into single setup
buildSrc/.../kmp-publish.gradle.kts	Renames dokka jar methods
buildSrc/.../jvm-module.gradle.kts	Consolidates dokka configuration
buildSrc/.../InceptionYear.kt	Refactors constant to public property
buildSrc/.../RepoSlug.kt	Fixes error message and git host URL
buildSrc/.../SpinePublishing.kt	Removes ProtoJar and DokkaJar configuration options
buildSrc/.../PublishingExts.kt	Updates artifact configuration for new dokka setup
buildSrc/.../PublicationHandler.kt	Adds POM metadata (inception year, SCM info)
buildSrc/.../JarDsl.kt	Removes DokkaJar and ProtoJar DSL classes
buildSrc/.../UpdateGitHubPagesExtension.kt	Removes internal javadoc configuration
buildSrc/.../UpdateGitHubPages.kt	Renames tasks and updates documentation format handling
buildSrc/.../Update.kt	Refactors documentation update to use format-based approach
buildSrc/.../TaskName.kt	Updates task names for new documentation structure
buildSrc/.../SshKey.kt	Updates SSH configuration for GitHub publishing
buildSrc/.../RepositoryExtensions.kt	Updates documentation clone method
buildSrc/.../Repository.kt	Adds logging and pull operations to git commands
buildSrc/.../LazyTempPath.kt	Removes nullable type parameters
buildSrc/.../TaskContainerExtensions.kt	Removes deprecated file
buildSrc/.../DokkaExtensions.kt	Removes deprecated file
buildSrc/.../Runtime.kt	Updates documentation and visibility
buildSrc/.../Validation.kt	Updates version to 354
buildSrc/.../CoreJvm.kt	Fixes repository URL in documentation
buildSrc/.../Compiler.kt	Updates fallback versions
buildSrc/.../Base.kt	Updates repository URL and version
buildSrc/.../Protobuf.kt	Updates version to 4.33.1
buildSrc/.../Dokka.kt	Updates version to 2.1.0
dokka-for-kotlin.gradle.kts	Removes deprecated plugin file
dokka-for-java.gradle.kts	Updates for new Dokka API
DokkaExts.kt	Refactors for new Dokka 2.1.0 API
DocumentationSettings.kt	Adds repository URL generation methods
BuildExtensions.kt	Updates task dependencies and adds duplication handling
buildSrc/build.gradle.kts	Updates Dokka version and adds Kotest dependencies
build.gradle.kts	Updates dokka plugin reference
api/.../Policy.kt	Simplifies documentation comment

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

buildSrc/src/main/kotlin/io/spine/gradle/repo/RepoSlug.kt

buildSrc/src/main/kotlin/io/spine/gradle/git/Repository.kt

buildSrc/src/main/kotlin/io/spine/dependency/local/Base.kt

Copilot · 2025-11-28T16:30:34Z

buildSrc/src/main/kotlin/io/spine/dependency/local/CoreJvm.kt

 * Dependencies on `core-java` modules.
 *
- * See [`SpineEventEngine/core-java`](https://github.com/SpineEventEngine/core-jvm/).
+ * See [`SpineEventEngine/core-java`](https://github.com/SpineEventEngine/core-java/).


The repository name is inconsistent. The link text says 'core-java' but according to line 32 comment, this module is about 'core-jvm'. Either the link text or the URL should be corrected to match the actual repository.

Copilot

Pull request overview

Copilot reviewed 57 out of 59 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (3)

test-env/src/main/kotlin/io/spine/tools/compiler/test/DocilePlugin.kt:1

The parameter name policies is inconsistent with its type Reaction<*>. Since the API has migrated from Policy to Reaction, the parameter should be renamed to reactions to match the type and maintain consistency with the parent class.
test-env/src/main/kotlin/io/spine/tools/compiler/test/DocilePlugin.kt:1
The constructor parameter policies is being passed to the reactions property of the parent class. This creates confusion as the names don't match. Consider renaming the parameter from policies to reactions to maintain consistency throughout the API migration.
jvm/src/main/kotlin/io/spine/tools/compiler/jvm/annotation/TypeAnnotationPlugin.kt:1
The parameter name policies is inconsistent with its type Reaction<*>. The parameter should be renamed to reactions to align with the API migration from Policy to Reaction.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 57 out of 59 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (2)

test-env/src/main/kotlin/io/spine/tools/compiler/test/DocilePlugin.kt:1

The parameter name policies is inconsistent with its type Reaction. It should be renamed to reactions to match the type and align with the API migration.
test-env/src/main/kotlin/io/spine/tools/compiler/test/DocilePlugin.kt:1
The parameter policies is being passed to the reactions property. This creates confusion due to the naming mismatch. The parameter should be renamed to reactions for clarity.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

chatgpt-codex-connector · 2025-11-28T18:01:09Z

buildSrc/src/main/kotlin/BuildExtensions.kt

+        val dokkaGenerate = "dokkaGenerate"
+        dokkaGenerate.run {
            dependOn(generateProto)
            dependOn(kspKotlin)
        }
-        val dokkaJavadoc = "dokkaJavadoc"
-        dokkaJavadoc.run {
-            dependOn(kspKotlin)
-        }
+        val dokkaGeneratePublicationJavadoc = "dokkaGeneratePublicationJavadoc"
+        dokkaGeneratePublicationJavadoc.dependOn(kspKotlin)
        "publishPluginJar".dependOn(createVersionFile)
        compileKotlin.dependOn(kspKotlin)
        compileTestKotlin.dependOn("kspTestKotlin")
        "compileTestFixturesKotlin".dependOn("kspTestFixturesKotlin")
-        "javadocJar".dependOn(dokkaHtml)
-        "dokkaKotlinJar".dependOn(dokkaJavadoc)
+        "javadocJar".dependOn(dokkaGeneratePublicationJavadoc)
+        "htmlDocsJar".dependOn(dokkaGenerate)


Wire html docs to real Dokka task

The dependency wiring for documentation still targets a task named dokkaGenerate, but the Dokka setup in this commit now exposes dokkaGeneratePublicationHtml/dokkaGeneratePublicationJavadoc instead (see the new dokkaHtmlTask() lookup). Because dokkaGenerate is never created, the dependOn(generateProto/kspKotlin) calls and the htmlDocsJar dependency become no-ops, so running htmlDocsJar/publishing from a clean checkout will no longer trigger Dokka or proto generation and can produce empty or stale documentation artifacts.

Useful? React with 👍 / 👎.

alexander-yevsyukov added 10 commits November 27, 2025 20:44

Fix broken KDoc links

82a0196

Temporarily disable the runtime check of Protobuf version compatibility

64569b7

Update config

94451fe

Update dependency reports

24e6144

Bump version -> 2.0.0-SNAPSHOT.031

4d9f788

Update dependency reports

5171754

Migrate to new CoreJvm

a261be7

Update config

74755c5

Update source code URL

de1c0ff

Bump Base -> 2.0.0-SNAPSHOT.380

3f897d5

Copilot AI review requested due to automatic review settings November 28, 2025 16:28

Copilot AI reviewed Nov 28, 2025

View reviewed changes

alexander-yevsyukov added 8 commits November 28, 2025 17:02

Add the Compiler to the build classpath

ac7599d

Bump CoreJvm Compiler -> 2.0.0-SNAPSHOT.029

0fab412

Update dependency reports

19a4836

Update the projection state inheritance

361952b

Rename Policy to Reaction

d6745e8

Fix the repo link

6ebde55

Fix the repo link

dd1e8f9

Update build time

4cd4643

alexander-yevsyukov requested a review from Copilot November 28, 2025 17:36

Copilot AI reviewed Nov 28, 2025

View reviewed changes

alexander-yevsyukov self-assigned this Nov 28, 2025

alexander-yevsyukov requested review from armiol and Copilot November 28, 2025 17:49

alexander-yevsyukov marked this pull request as ready for review November 28, 2025 17:52

alexander-yevsyukov enabled auto-merge November 28, 2025 17:53

armiol approved these changes Nov 28, 2025

View reviewed changes

alexander-yevsyukov merged commit b463b17 into master Nov 28, 2025
13 of 16 checks passed

alexander-yevsyukov deleted the migrate-to-reaction-api branch November 28, 2025 17:57

Copilot AI reviewed Nov 28, 2025

View reviewed changes

chatgpt-codex-connector bot reviewed Nov 28, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Migrate to `Reaction` API #47

Migrate to `Reaction` API #47

Uh oh!

alexander-yevsyukov commented Nov 28, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Nov 28, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

chatgpt-codex-connector bot left a comment

Uh oh!

chatgpt-codex-connector bot Nov 28, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Migrate to Reaction API #47

Migrate to Reaction API #47

Uh oh!

Conversation

alexander-yevsyukov commented Nov 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Other notable changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Nov 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

chatgpt-codex-connector bot Nov 28, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Migrate to `Reaction` API #47

Migrate to `Reaction` API #47

alexander-yevsyukov commented Nov 28, 2025 •

edited

Loading