Skip to content

Update embed-code #280

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
alexander-yevsyukov merged 26 commits into from
Mar 23, 2026
Merged

Update embed-code #280

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
5fbd933
Update `embed-code` binaries
alexander-yevsyukov Mar 23, 2026
1a02cbc
Bump version -> `2.0.0-SNAPSHOT.406`
alexander-yevsyukov Mar 23, 2026
890f384
Update `config` ref.
alexander-yevsyukov Mar 23, 2026
8c8ddfa
Bump Gradle -> `9.4.0`
alexander-yevsyukov Mar 23, 2026
b0d7858
Update dependency reports
alexander-yevsyukov Mar 23, 2026
bff83f5
Add trailing new line
alexander-yevsyukov Mar 23, 2026
19faa10
Sort out imports
alexander-yevsyukov Mar 23, 2026
f2fcbca
Remove unnecessary overrides
alexander-yevsyukov Mar 23, 2026
c5a486f
Update dependency reports
alexander-yevsyukov Mar 23, 2026
9650dec
Bump Validation -> `2.0.0-SNAPSHOT.405`
alexander-yevsyukov Mar 23, 2026
90ea3e5
Add execution permissions
alexander-yevsyukov Mar 23, 2026
a78742c
Add named code roots
alexander-yevsyukov Mar 23, 2026
913db7e
Bump Validation version
alexander-yevsyukov Mar 23, 2026
8db2c82
Bump Validation version
alexander-yevsyukov Mar 23, 2026
9bd5a20
Remove `embed-mappings` section
alexander-yevsyukov Mar 23, 2026
c9c2932
Capitalize parameter descriptions
alexander-yevsyukov Mar 23, 2026
f484573
Update `MessageValidator` docs to match the recent changes
alexander-yevsyukov Mar 23, 2026
94084c3
Improve text wrapping
alexander-yevsyukov Mar 23, 2026
5f93f54
Improve code embedding
alexander-yevsyukov Mar 23, 2026
b491aa0
Update build time
alexander-yevsyukov Mar 23, 2026
a381e69
Wrap `embed-code` parameters
alexander-yevsyukov Mar 23, 2026
99bdcd8
Reduce using braces
alexander-yevsyukov Mar 23, 2026
2ad5ceb
Fix typo
alexander-yevsyukov Mar 23, 2026
e9b3b15
Simplify link
alexander-yevsyukov Mar 23, 2026
8e1c9a7
Fix typo
alexander-yevsyukov Mar 23, 2026
3d156b9
Fix path to the Linux binary for GitHub
alexander-yevsyukov Mar 23, 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
2 changes: 1 addition & 1 deletion .idea/inspectionProfiles/Project_Default.xml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion buildSrc/src/main/kotlin/io/spine/dependency/local/Validation.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ object Validation {
/**
* The version of the Validation library artifacts.
*/
const val version = "2.0.0-SNAPSHOT.404"
const val version = "2.0.0-SNAPSHOT.405"

/**
* The last version of Validation compatible with ProtoData.
Expand Down
2 changes: 1 addition & 1 deletion buildSrc/src/main/kotlin/io/spine/gradle/kotlin/KotlinConfig.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@
package io.spine.gradle.kotlin

import org.gradle.jvm.toolchain.JavaLanguageVersion
import org.jetbrains.kotlin.gradle.dsl.JvmDefaultMode
import org.jetbrains.kotlin.gradle.dsl.KotlinCommonCompilerOptions
import org.jetbrains.kotlin.gradle.dsl.KotlinJvmCompilerOptions
import org.jetbrains.kotlin.gradle.dsl.KotlinJvmProjectExtension
import org.jetbrains.kotlin.gradle.dsl.JvmDefaultMode

/**
* Sets [Java toolchain](https://kotlinlang.org/docs/gradle.html#gradle-java-toolchains-support)
Expand Down
4 changes: 0 additions & 4 deletions buildSrc/src/main/kotlin/io/spine/gradle/testing/Logging.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,10 +79,6 @@ fun Test.configureLogging() {
logger.lifecycle(result.summary())
}
}

override fun beforeSuite(suite: TestDescriptor?) = Unit
override fun beforeTest(testDescriptor: TestDescriptor?) = Unit
override fun afterTest(testDescriptor: TestDescriptor?, result: TestResult?) = Unit
}

addTestListener(listener)
Expand Down
2 changes: 1 addition & 1 deletion config
Open in desktop
Submodule config updated 5 files
+6 −1 buildSrc/src/main/kotlin/io/spine/dependency/local/Compiler.kt
+6 −2 buildSrc/src/main/kotlin/io/spine/dependency/local/CoreJvmCompiler.kt
+1 −1 buildSrc/src/main/kotlin/io/spine/dependency/local/Validation.kt
+1 −1 buildSrc/src/main/kotlin/io/spine/dependency/test/JUnit.kt
+2 −2 buildSrc/src/main/kotlin/io/spine/gradle/kotlin/KotlinConfig.kt
60 changes: 30 additions & 30 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.tools:validation-context:2.0.0-SNAPSHOT.405`
# Dependencies of `io.spine.tools:validation-context:2.0.0-SNAPSHOT.406`

## Runtime
1. **Group** : com.fasterxml.jackson. **Name** : jackson-bom. **Version** : 2.20.0.
Expand Down Expand Up @@ -1139,14 +1139,14 @@

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

This report was generated on **Thu Mar 12 21:14:30 WET 2026** using
This report was generated on **Mon Mar 23 17:45:43 WET 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.tools:validation-context-tests:2.0.0-SNAPSHOT.405`
# Dependencies of `io.spine.tools:validation-context-tests:2.0.0-SNAPSHOT.406`

## Runtime
1. **Group** : com.fasterxml.jackson. **Name** : jackson-bom. **Version** : 2.20.0.
Expand Down Expand Up @@ -1743,28 +1743,28 @@ This report was generated on **Thu Mar 12 21:14:30 WET 2026** using

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

This report was generated on **Thu Mar 12 21:14:30 WET 2026** using
This report was generated on **Mon Mar 23 17:45:43 WET 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.tools:validation-docs:2.0.0-SNAPSHOT.405`
# Dependencies of `io.spine.tools:validation-docs:2.0.0-SNAPSHOT.406`

## Runtime
## Compile, tests, and tooling

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

This report was generated on **Thu Mar 12 21:14:29 WET 2026** using
This report was generated on **Mon Mar 23 16:41:13 WET 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.tools:validation-gradle-plugin:2.0.0-SNAPSHOT.405`
# Dependencies of `io.spine.tools:validation-gradle-plugin:2.0.0-SNAPSHOT.406`

## Runtime
1. **Group** : com.fasterxml.jackson. **Name** : jackson-bom. **Version** : 2.20.0.
Expand Down Expand Up @@ -2881,14 +2881,14 @@ This report was generated on **Thu Mar 12 21:14:29 WET 2026** using

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

This report was generated on **Thu Mar 12 21:14:30 WET 2026** using
This report was generated on **Mon Mar 23 17:45:43 WET 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.tools:validation-java:2.0.0-SNAPSHOT.405`
# Dependencies of `io.spine.tools:validation-java:2.0.0-SNAPSHOT.406`

## Runtime
1. **Group** : com.fasterxml.jackson. **Name** : jackson-bom. **Version** : 2.20.0.
Expand Down Expand Up @@ -3967,14 +3967,14 @@ This report was generated on **Thu Mar 12 21:14:30 WET 2026** using

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

This report was generated on **Thu Mar 12 21:14:30 WET 2026** using
This report was generated on **Mon Mar 23 17:45:43 WET 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.tools:validation-java-bundle:2.0.0-SNAPSHOT.405`
# Dependencies of `io.spine.tools:validation-java-bundle:2.0.0-SNAPSHOT.406`

## Runtime
1. **Group** : org.jetbrains. **Name** : annotations. **Version** : 13.0.
Expand Down Expand Up @@ -4021,14 +4021,14 @@ This report was generated on **Thu Mar 12 21:14:30 WET 2026** using

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

This report was generated on **Thu Mar 12 21:14:30 WET 2026** using
This report was generated on **Mon Mar 23 17:45:42 WET 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:validation-jvm-runtime:2.0.0-SNAPSHOT.405`
# Dependencies of `io.spine:validation-jvm-runtime:2.0.0-SNAPSHOT.406`

## Runtime
1. **Group** : com.google.code.findbugs. **Name** : jsr305. **Version** : 3.0.2.
Expand Down Expand Up @@ -4861,14 +4861,14 @@ This report was generated on **Thu Mar 12 21:14:30 WET 2026** using

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

This report was generated on **Thu Mar 12 21:14:30 WET 2026** using
This report was generated on **Mon Mar 23 17:45:43 WET 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.tools:validation-consumer:2.0.0-SNAPSHOT.405`
# Dependencies of `io.spine.tools:validation-consumer:2.0.0-SNAPSHOT.406`

## Runtime
1. **Group** : com.fasterxml.jackson. **Name** : jackson-bom. **Version** : 2.20.0.
Expand Down Expand Up @@ -5455,14 +5455,14 @@ This report was generated on **Thu Mar 12 21:14:30 WET 2026** using

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

This report was generated on **Thu Mar 12 21:14:30 WET 2026** using
This report was generated on **Mon Mar 23 17:45:42 WET 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.tools:validation-consumer-dependency:2.0.0-SNAPSHOT.405`
# Dependencies of `io.spine.tools:validation-consumer-dependency:2.0.0-SNAPSHOT.406`

## Runtime
1. **Group** : com.google.code.findbugs. **Name** : jsr305. **Version** : 3.0.2.
Expand Down Expand Up @@ -5985,14 +5985,14 @@ This report was generated on **Thu Mar 12 21:14:30 WET 2026** using

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

This report was generated on **Thu Mar 12 21:14:30 WET 2026** using
This report was generated on **Mon Mar 23 17:45:43 WET 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.tools:validation-extensions:2.0.0-SNAPSHOT.405`
# Dependencies of `io.spine.tools:validation-extensions:2.0.0-SNAPSHOT.406`

## Runtime
1. **Group** : com.fasterxml.jackson. **Name** : jackson-bom. **Version** : 2.20.0.
Expand Down Expand Up @@ -6684,14 +6684,14 @@ This report was generated on **Thu Mar 12 21:14:30 WET 2026** using

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

This report was generated on **Thu Mar 12 21:14:30 WET 2026** using
This report was generated on **Mon Mar 23 17:45:43 WET 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.tools:validation-runtime:2.0.0-SNAPSHOT.405`
# Dependencies of `io.spine.tools:validation-runtime:2.0.0-SNAPSHOT.406`

## Runtime
1. **Group** : com.google.code.findbugs. **Name** : jsr305. **Version** : 3.0.2.
Expand Down Expand Up @@ -7329,14 +7329,14 @@ This report was generated on **Thu Mar 12 21:14:30 WET 2026** using

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

This report was generated on **Thu Mar 12 21:14:30 WET 2026** using
This report was generated on **Mon Mar 23 17:45:43 WET 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.tools:validation-validating:2.0.0-SNAPSHOT.405`
# Dependencies of `io.spine.tools:validation-validating:2.0.0-SNAPSHOT.406`

## Runtime
1. **Group** : com.google.code.findbugs. **Name** : jsr305. **Version** : 3.0.2.
Expand Down Expand Up @@ -8013,14 +8013,14 @@ This report was generated on **Thu Mar 12 21:14:30 WET 2026** using

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

This report was generated on **Thu Mar 12 21:14:30 WET 2026** using
This report was generated on **Mon Mar 23 17:45:43 WET 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.tools:validation-validator:2.0.0-SNAPSHOT.405`
# Dependencies of `io.spine.tools:validation-validator:2.0.0-SNAPSHOT.406`

## Runtime
1. **Group** : com.fasterxml.jackson. **Name** : jackson-bom. **Version** : 2.20.0.
Expand Down Expand Up @@ -8807,14 +8807,14 @@ This report was generated on **Thu Mar 12 21:14:30 WET 2026** using

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

This report was generated on **Thu Mar 12 21:14:30 WET 2026** using
This report was generated on **Mon Mar 23 17:45:43 WET 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.tools:validation-validator-dependency:2.0.0-SNAPSHOT.405`
# Dependencies of `io.spine.tools:validation-validator-dependency:2.0.0-SNAPSHOT.406`

## Runtime
1. **Group** : com.google.code.findbugs. **Name** : jsr305. **Version** : 3.0.2.
Expand Down Expand Up @@ -9088,14 +9088,14 @@ This report was generated on **Thu Mar 12 21:14:30 WET 2026** using

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

This report was generated on **Thu Mar 12 21:14:30 WET 2026** using
This report was generated on **Mon Mar 23 17:45:43 WET 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.tools:validation-vanilla:2.0.0-SNAPSHOT.405`
# Dependencies of `io.spine.tools:validation-vanilla:2.0.0-SNAPSHOT.406`

## Runtime
1. **Group** : com.google.code.findbugs. **Name** : jsr305. **Version** : 3.0.2.
Expand Down Expand Up @@ -9442,6 +9442,6 @@ This report was generated on **Thu Mar 12 21:14:30 WET 2026** using

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

This report was generated on **Thu Mar 12 21:14:30 WET 2026** using
This report was generated on **Mon Mar 23 17:45:42 WET 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).
Binary file added docs/_bin/embed-code-linux
View file
Open in desktop
Binary file not shown.
Binary file modified docs/_bin/embed-code-macos
View file
Open in desktop
Binary file not shown.
Binary file removed docs/_bin/embed-code-macos-x86_64
View file
Open in desktop
Binary file not shown.
Binary file removed docs/_bin/embed-code-ubuntu
View file
Open in desktop
Binary file not shown.
Binary file added docs/_bin/embed-code-windows.exe
View file
Open in desktop
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_examples
Open in desktop
Submodule _examples updated 3 files
+1 −1 external/build.gradle.kts
+1 −1 first-model-with-framework/build.gradle.kts
+1 −1 first-model/build.gradle.kts
4 changes: 2 additions & 2 deletions docs/_script/check-samples
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ fi
# Navigate to the folder with embed-code binaries.
cd _bin

# Use the Ubuntu binary for GitHub Actions and macOS binary in other cases.
# Use the Linux binary for GitHub Actions and macOS binary in other cases.
if [ "$GITHUB_ACTIONS" = "true" ]; then
echo "Running in GitHub Action."
TOOL="./embed-code-ubuntu"
TOOL="./embed-code-linux"
else
echo "Running locally on macOS."
TOOL="./embed-code-macos"
Expand Down
9 changes: 5 additions & 4 deletions docs/_settings/embed-code.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
code-path: "../_examples"
code-path:
- name: "examples"
path: "../_examples"
- name: "runtime"
path: "../../jvm-runtime"
docs-path: "../content/docs/"
embed-mappings:
- code-path: "../_examples"
docs-path: "../content/docs/"
22 changes: 17 additions & 5 deletions docs/content/docs/validation/01-getting-started/adding-to-build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,11 @@ headline: Documentation

## Adding Spine-specific Gradle plugin repositories

<embed-code file="settings.gradle.kts" start="pluginManagement {" end="^}"></embed-code>
<embed-code
file="$examples/settings.gradle.kts"
start="pluginManagement {"
end="^}">
</embed-code>
```kotlin
pluginManagement {
repositories {
Expand Down Expand Up @@ -78,11 +82,15 @@ Use this mode if you want to run Validation without the rest of Spine.

Add the Validation plugin to the build.

<embed-code file="first-model/build.gradle.kts" start="plugins {" end="^}"></embed-code>
<embed-code
file="$examples/first-model/build.gradle.kts"
start="plugins {"
end="^}">
</embed-code>
```kotlin
plugins {
module
id("io.spine.validation") version "2.0.0-SNAPSHOT.404"
id("io.spine.validation") version "2.0.0-SNAPSHOT.406"
}
```

Expand All @@ -104,11 +112,15 @@ the JVM runtime dependency automatically.
If your project is based on the Spine CoreJvm library, apply the CoreJvm Gradle plugin instead of
adding Validation directly. CoreJvm brings in the Validation Gradle plugin for you.

<embed-code file="first-model-with-framework/build.gradle.kts" start="plugins {" end="^}"></embed-code>
<embed-code
file="$examples/first-model-with-framework/build.gradle.kts"
start="plugins {"
end="^}">
</embed-code>
```kotlin
plugins {
module
id("io.spine.core-jvm") version "2.0.0-SNAPSHOT.054"
id("io.spine.core-jvm") version "2.0.0-SNAPSHOT.055"
}
```

Expand Down
6 changes: 5 additions & 1 deletion docs/content/docs/validation/01-getting-started/first-model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,11 @@ The validation options come from `spine/options.proto` and include constraints l

Create a `.proto` file and import `spine/options.proto`:

<embed-code file="first-model/src/main/proto/spine/validation/docs/first_model/bank_card.proto" start="syntax" end="^}"></embed-code>
<embed-code
file="$examples/first-model/src/main/proto/spine/validation/docs/first_model/bank_card.proto"
start="syntax"
end="^}">
</embed-code>
```protobuf
syntax = "proto3";

Expand Down
Loading
Loading