Skip to content

Update codegen-plugins docs #128

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

Merged
Oleg-Melnik merged 2 commits into from
Apr 24, 2026
+23 −22
Merged

Update codegen-plugins docs #128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c3f42b
Update docs.
Oleg-Melnik Apr 24, 2026
25727e6
Bump version —> `2.0.0-SNAPSHOT.85`.
Oleg-Melnik Apr 24, 2026
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
17 changes: 9 additions & 8 deletions codegen/plugins/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
# `codegen-plugins`

A separate Gradle project with ProtoData plugins which generate
[MessageField](codegen/runtime/src/main/kotlin/io/spine/chords/runtime/MessageField.kt),
[MessageOneof](codegen/runtime/src/main/kotlin/io/spine/chords/runtime/MessageOneof.kt),
and [MessageDef](codegen/runtime/src/main/kotlin/io/spine/chords/runtime/MessageDef.kt)
[MessageField](../runtime/src/main/kotlin/io/spine/chords/runtime/MessageField.kt),
[MessageOneof](../runtime/src/main/kotlin/io/spine/chords/runtime/MessageOneof.kt),
and [MessageDef](../runtime/src/main/kotlin/io/spine/chords/runtime/MessageDef.kt)
implementations for Proto messages. Also, some other useful Kotlin extensions are generated,
e.g. `ValidatingBuilder.messageDef()` that returns the instance of `MessageDef` implementation
for the current message builder.

The separate Gradle project is needed because the ProtoData plugins,
which generate the code, require the newer version of Gradle, `7.6.x` at the moment,
comparing to Chords-based projects, which require Gradle version `6.9.x`.
The separate Gradle project is needed because the `ProtoData` plugins,
which generate the code, require the newer version of Gradle, `9.4.x` at the moment,
and Java 17, comparing to Chords-based projects, which require Gradle version `6.9.x` and Java 11.

### Requirements

- Java 11
- Gradle `7.6.x`
- Java 17
- Gradle `9.4.x`
- Kotlin `2.3.20`

### How to use

Expand Down
24 changes: 12 additions & 12 deletions dependencies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@


# Dependencies of `io.spine.chords:spine-chords-client:2.0.0-SNAPSHOT.84`
# Dependencies of `io.spine.chords:spine-chords-client:2.0.0-SNAPSHOT.85`

## Runtime
1. **Group** : cafe.adriel.voyager. **Name** : voyager-core. **Version** : 1.0.1.**No license information found**
Expand Down Expand Up @@ -1104,12 +1104,12 @@

The dependencies distributed under several licenses, are used according their commercial-use-friendly license.

This report was generated on **Thu Apr 23 23:42:00 EEST 2026** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).
This report was generated on **Fri Apr 24 15:33:54 EEST 2026** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).




# Dependencies of `io.spine.chords:spine-chords-codegen-tests:2.0.0-SNAPSHOT.84`
# Dependencies of `io.spine.chords:spine-chords-codegen-tests:2.0.0-SNAPSHOT.85`

## Runtime
1. **Group** : com.google.code.findbugs. **Name** : jsr305. **Version** : 3.0.2.
Expand Down Expand Up @@ -1899,12 +1899,12 @@ This report was generated on **Thu Apr 23 23:42:00 EEST 2026** using [Gradle-Lic

The dependencies distributed under several licenses, are used according their commercial-use-friendly license.

This report was generated on **Thu Apr 23 23:42:01 EEST 2026** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).
This report was generated on **Fri Apr 24 15:33:55 EEST 2026** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).




# Dependencies of `io.spine.chords:spine-chords-core:2.0.0-SNAPSHOT.84`
# Dependencies of `io.spine.chords:spine-chords-core:2.0.0-SNAPSHOT.85`

## Runtime
1. **Group** : cafe.adriel.voyager. **Name** : voyager-core. **Version** : 1.0.1.
Expand Down Expand Up @@ -2938,12 +2938,12 @@ This report was generated on **Thu Apr 23 23:42:01 EEST 2026** using [Gradle-Lic

The dependencies distributed under several licenses, are used according their commercial-use-friendly license.

This report was generated on **Thu Apr 23 23:42:03 EEST 2026** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).
This report was generated on **Fri Apr 24 15:33:56 EEST 2026** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).




# Dependencies of `io.spine.chords:spine-chords-proto:2.0.0-SNAPSHOT.84`
# Dependencies of `io.spine.chords:spine-chords-proto:2.0.0-SNAPSHOT.85`

## Runtime
1. **Group** : cafe.adriel.voyager. **Name** : voyager-core. **Version** : 1.0.1.**No license information found**
Expand Down Expand Up @@ -3976,12 +3976,12 @@ This report was generated on **Thu Apr 23 23:42:03 EEST 2026** using [Gradle-Lic

The dependencies distributed under several licenses, are used according their commercial-use-friendly license.

This report was generated on **Thu Apr 23 23:42:04 EEST 2026** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).
This report was generated on **Fri Apr 24 15:33:57 EEST 2026** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).




# Dependencies of `io.spine.chords:spine-chords-proto-values:2.0.0-SNAPSHOT.84`
# Dependencies of `io.spine.chords:spine-chords-proto-values:2.0.0-SNAPSHOT.85`

## Runtime
1. **Group** : com.google.code.findbugs. **Name** : jsr305. **Version** : 3.0.2.
Expand Down Expand Up @@ -4775,12 +4775,12 @@ This report was generated on **Thu Apr 23 23:42:04 EEST 2026** using [Gradle-Lic

The dependencies distributed under several licenses, are used according their commercial-use-friendly license.

This report was generated on **Thu Apr 23 23:42:05 EEST 2026** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).
This report was generated on **Fri Apr 24 15:33:59 EEST 2026** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).




# Dependencies of `io.spine.chords:spine-chords-runtime:2.0.0-SNAPSHOT.84`
# Dependencies of `io.spine.chords:spine-chords-runtime:2.0.0-SNAPSHOT.85`

## Runtime
1. **Group** : com.google.code.findbugs. **Name** : jsr305. **Version** : 3.0.2.
Expand Down Expand Up @@ -5544,4 +5544,4 @@ This report was generated on **Thu Apr 23 23:42:05 EEST 2026** using [Gradle-Lic

The dependencies distributed under several licenses, are used according their commercial-use-friendly license.

This report was generated on **Thu Apr 23 23:42:06 EEST 2026** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).
This report was generated on **Fri Apr 24 15:33:59 EEST 2026** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).
2 changes: 1 addition & 1 deletion pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ all modules and does not describe the project structure per-subproject.
-->
<groupId>io.spine.chords</groupId>
<artifactId>Chords</artifactId>
<version>2.0.0-SNAPSHOT.84</version>
<version>2.0.0-SNAPSHOT.85</version>

<inceptionYear>2015</inceptionYear>

Expand Down
2 changes: 1 addition & 1 deletion version.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@
/**
* The version of all Chords libraries.
*/
val chordsVersion: String by extra("2.0.0-SNAPSHOT.84")
val chordsVersion: String by extra("2.0.0-SNAPSHOT.85")
Loading