Docs set 1 #261

alexander-yevsyukov · 2026-01-20T19:57:17Z

No description provided.

Copilot

Pull request overview

This PR updates project documentation by replacing informal "Please note" phrases with more concise "Note that" phrasing, and bumps version numbers across multiple configuration files and documentation.

Changes:

Simplified documentation language by removing "Please" prefix from note statements
Updated version from 2.0.0-SNAPSHOT.393 to 2.0.0-SNAPSHOT.394 across configuration files
Updated dependency versions (CoreJvmCompiler from .050 to .051, validation-jvm-runtime from .392 to .393)

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
version.gradle.kts	Bumped validation version to .394
tests/consumer/src/test/kotlin/io/spine/validation/test/CurrencyOptionITest.kt	Removed "Please" from documentation note
pom.xml	Updated project version to .394 and dependency versions
jvm-runtime/src/main/kotlin/io/spine/validation/MessageValidator.kt	Simplified "Please note" to "Note" in KDoc
java/src/main/kotlin/io/spine/tools/validation/java/setonce/SetOnceEnumField.kt	Condensed and simplified documentation note
java/src/main/kotlin/io/spine/tools/validation/java/setonce/SetOnceBytesField.kt	Condensed and simplified documentation note
java/src/main/kotlin/io/spine/tools/validation/java/JavaValidationPlugin.kt	Reformatted multi-line KDoc note for clarity
docs/01-getting-started/index.md	Improved line wrapping for better readability
dependencies.md	Updated version references and generation timestamps
config	Updated subproject commit reference
buildSrc/src/main/kotlin/io/spine/dependency/local/Validation.kt	Updated validation version constant to .393
buildSrc/src/main/kotlin/io/spine/dependency/local/CoreJvmCompiler.kt	Updated CoreJvmCompiler versions to .051

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

Also: * Update the reference to Jakarta Validation, addressing the recent name change.

Also: * Update Kotlin requirement to 2.2.21+.

Copilot

Pull request overview

Copilot reviewed 20 out of 20 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (2)

docs/options.proto:1

Corrected spelling of 'please' to 'use' for consistency with the PR's goal of removing informal language like 'Please' from comments.

/*

docs/ToC.md:1

These link text entries still use title case capitalization ("First Validated Model", "Validation Workflow") while other entries in the same file have been updated to sentence case. These should be changed to "Your first validated model" and "Validation workflow" for consistency.

# Spine Validation — Table of contents

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

Copilot · 2026-01-22T20:43:29Z

docs/content/docs/validation/00-intro/index.md


-## What’s Next
+## What's next

 - [Target Audience](target-audience.md)


The link text "Target Audience" uses title case, but the PR has changed the target file's heading to sentence case "Target audience". The link text should match for consistency.

Suggested change

- [Target Audience](target-audience.md)

- [Target audience](target-audience.md)

Copilot

Pull request overview

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

Files not reviewed (1)

.idea/inspectionProfiles/Project_Default.xml: Language not supported

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

Copilot

Pull request overview

Copilot reviewed 61 out of 70 changed files in this pull request and generated 1 comment.

Files not reviewed (2)

.idea/inspectionProfiles/Project_Default.xml: Language not supported
docs/_preview/package-lock.json: Language not supported

Comments suppressed due to low confidence (8)

docs/gradlew.bat:1

This file appears to contain an absolute path to a user's local file system rather than being an actual Gradle wrapper script. Gradle wrapper files should contain the wrapper script content, not file paths. This will not work for other developers or in CI environments.
docs/gradlew:1
This file appears to contain an absolute path to a user's local file system rather than being an actual Gradle wrapper script. Gradle wrapper files should contain the wrapper script content, not file paths. This will not work for other developers or in CI environments.
docs/gradle.properties:1
This file contains only a relative path instead of actual Gradle properties. While this might be intended as a symbolic link reference, it won't work as a regular file. Consider either copying the properties or using Gradle's project structure to reference parent properties.
docs/_code/first-model/gradlew.bat:1
This file contains an absolute path to a user's local file system rather than the actual Gradle wrapper script. This will not work for other developers or in CI environments.
docs/_code/first-model/gradlew:1
This file contains an absolute path to a user's local file system rather than the actual Gradle wrapper script. This will not work for other developers or in CI environments.
docs/_code/first-model/gradle.properties:1
This file contains an absolute path to a user's local file system rather than actual Gradle properties. This will not work for other developers or in CI environments.
docs/_code/first-model/buildSrc:1
This file contains only an absolute path reference. buildSrc directories should contain actual build source code, not file path references. This will not work for other developers or in CI environments.
docs/content/docs/validation/01-getting-started/first-model.md:1
Corrected spelling of 'simplified' - the word is correct but the pattern on line 32 appears to have an issue. The regex pattern ^\\d{4}(?: \\d{4}){3} expects exactly 4 groups of 4 digits (16 total), but the comment says 'simplified'.

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

Copilot · 2026-02-05T18:35:11Z

docs/_code/first-model/src/main/proto/spine/validation/docs/first_model/bank_card.proto

+        (pattern).regex = "^\\d{4}(?: \\d{4}){3}"
+    ];
+
+    // Must be present and contain at least 4 Latin letters or spaces.


The regex pattern requires at least 4 characters total ([A-Z] + at least 2 from [A-Za-z ] + [A-Za-z]), but the comment on line 23 states 'at least 4 Latin letters or spaces'. This pattern actually allows spaces to count toward the minimum, and the ending [A-Za-z] prevents names from ending with a space. The pattern doesn't precisely match the stated requirement. Consider using ^[A-Z](?:[A-Za-z] ){2,}[A-Za-z]$ if spaces between words are required, or clarify the requirements.

Suggested change

// Must be present and contain at least 4 Latin letters or spaces.

// Must be present, contain at least 4 characters, start and end with a Latin letter,

// and may contain spaces between words.

Also: * Remove (c) headers from scripts. * Update `GRADLE.md` to reflect path relative to the `docs` directory.

Copilot

Pull request overview

Copilot reviewed 62 out of 71 changed files in this pull request and generated 1 comment.

Files not reviewed (2)

.idea/inspectionProfiles/Project_Default.xml: Language not supported
docs/_preview/package-lock.json: Language not supported

Comments suppressed due to low confidence (1)

docs/_script/hugo-serve:1

Corrected spelling of '_preivew' to '_preview'.

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

Copilot · 2026-02-05T20:26:10Z

docs/GRADLE.md

+## Including example sources
+
+It is done in the [`settings.gradle.kts`](settings.gradle.kts) file via `includeBuild` directive.
+If you add another example proejct, please remember to update


Corrected spelling of 'proejct' to 'project'.

Suggested change

If you add another example proejct, please remember to update

If you add another example project, please remember to update

Also: * Stop using `includeBuild`.

... in favour of `RunGradle` tasks.

Copilot

Pull request overview

Copilot reviewed 64 out of 73 changed files in this pull request and generated 1 comment.

Files not reviewed (2)

.idea/inspectionProfiles/Project_Default.xml: Language not supported
docs/_preview/package-lock.json: Language not supported

Comments suppressed due to low confidence (7)

docs/_script/hugo-serve:1

Directory name looks misspelled (_preivew vs _preview). This will make the script run Hugo from the wrong working directory (or fail to cd). Rename to cd _preview.
docs/_script/hugo-serve:1
This script uses unquoted variable expansions and sources user-controlled shell init files. For reliability, quote variables in test/source operations (e.g., \"$BASH_PROFILE\") and consider avoiding sourcing user profiles entirely (or gating it behind an explicit flag) to keep the docs build deterministic.
docs/_script/hugo-build:1
Same quoting/determinism concerns as in hugo-serve: quote variable expansions and reconsider sourcing user shell init files from build scripts to avoid environment-dependent behavior.
docs/_script/install-dependencies:1
Same quoting/determinism concerns as in other scripts. Also consider adding set -e to fail fast if cd _preview or npm install fails.
jvm-runtime/build.gradle.kts:1
Switching from implementation to api changes the published dependency surface of jvm-runtime (consumers now see/resolve Base.lib transitively). Unless Base.lib types are intentionally part of this module’s public API, prefer keeping it as implementation to avoid leaking internals and to reduce downstream dependency coupling.
docs/content/docs/validation/01-getting-started/adding-to-build.md:1
Typo: base on → based on.
docs/_settings/embed-code.yml:1
The top-level code-path/docs-path duplicates the single entry in embed-mappings with identical values. Consider keeping only one source of truth (either remove the redundant top-level keys or remove the redundant embedded mapping) to avoid future drift.

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

Copilot · 2026-02-09T20:27:08Z

buildSrc/src/main/kotlin/BuildSettings.kt

@@ -39,4 +39,5 @@ object BuildSettings {
    val javaVersionCompat = JavaVersion.toVersion(JVM_VERSION)
    val jvmTarget = JvmTarget.JVM_17
    const val REMOTE_DEBUG_PORT = 5566


This introduces a magic-number timeout without context. Consider adding a short KDoc/line comment explaining what this timeout is used for, and/or naming it more specifically (e.g., DOCS_BUILD_TIMEOUT_MINUTES, CI_TASK_TIMEOUT_MINUTES) so its scope is clear.

Suggested change

const val REMOTE_DEBUG_PORT = 5566

const val REMOTE_DEBUG_PORT = 5566

/**

* Default timeout (in minutes) for long-running Gradle tasks in CI.

*/

alexander-yevsyukov added 5 commits January 20, 2026 19:52

Reduce using "please" in docs

d1a3200

Improve text layout

11c6121

Bump version -> 2.0.0-SNAPSHOT.394

b16788a

Bump Validation and CoreJvm Compiler

9c0a34b

Update dependency reports

6379b9f

Copilot AI review requested due to automatic review settings January 20, 2026 19:57

alexander-yevsyukov self-assigned this Jan 20, 2026

alexander-yevsyukov added 2 commits January 20, 2026 19:57

Merge remote-tracking branch 'origin/master' into docs-set-1

1d17e3b

Update config ref.

1397636

Copilot AI reviewed Jan 20, 2026

View reviewed changes

alexander-yevsyukov added 17 commits January 21, 2026 18:28

Remove "Migration Guide" section

6e2fe2b

Improve text layout

479c28c

Remove unnecessary decorations

4230509

Remove hallucinated section links

77bbd9c

Remove redundant horizontal lines

4bf36f0

Convert titles to sentence case

09a9d47

Allow empty lines after headers

90bc7db

Fix the proto options example

78da3fb

Also: * Update the reference to Jakarta Validation, addressing the recent name change.

Use braces around proto options

2d1f0aa

Temporarily add source code of proto options

0300e79

Fix capitalization

94f69c0

Also: * Update Kotlin requirement to 2.2.21+.

Backtick code in ToC

449a789

Put the "Collection constraints" section after "Temporal constraints"

3671ae4

Describe Validation components

16a2736

Remove "Configuration & tooling" section

7fb87ac

Rename "Installation" to "Adding Validation to your build"

51c5036

Describe adding Validation to a Gradle build

d3d0b60

Copilot AI review requested due to automatic review settings January 22, 2026 20:42

Copilot AI reviewed Jan 22, 2026

View reviewed changes

Improve the example type name in the ValidationError docs

5383ae2

Rename _site to _preview

c475633

Copilot AI review requested due to automatic review settings February 4, 2026 19:08

Copilot AI reviewed Feb 4, 2026

View reviewed changes

alexander-yevsyukov added 6 commits February 4, 2026 20:25

Add content for the preview

eff6d99

Fix placement of _index.md

d383d34

Fix import of site-commons

f340143

Add buildAll tasks for building embedded code

3b8236c

Obtain the example version from the main code build

ae5826b

Use the same gradle.properties for the documentation Gradle build

d085a55

Copilot AI review requested due to automatic review settings February 5, 2026 18:26

Copilot AI reviewed Feb 5, 2026

View reviewed changes

alexander-yevsyukov added 3 commits February 5, 2026 19:06

Document Gradle project of the documentation

091f906

Fix relative paths in scripts

bf1ace9

Also: * Remove (c) headers from scripts. * Update `GRADLE.md` to reflect path relative to the `docs` directory.

Fix symlinks to use relative paths

9b38339

Copilot AI review requested due to automatic review settings February 5, 2026 20:15

alexander-yevsyukov added 2 commits February 5, 2026 20:17

Fix import placement

90bdaf4

Bump Gradle -> 9.3.1

181ba88

Copilot AI reviewed Feb 5, 2026

View reviewed changes

alexander-yevsyukov added 7 commits February 9, 2026 19:45

Ignore _out directories in _code subprojects

75a0f4e

Do not use code from buildSrc in example projects

011527b

Add TIMEOUT_MINUTES property

d299f4d

Refer to Spine Maven repositories for plugin management

ca70c08

Also: * Stop using `includeBuild`.

Stop using includeBuild

169e733

... in favour of `RunGradle` tasks.

Build firat-model via RunGradle

a6adb93

Add docs/buildSrc reference

5edee38

Copilot AI review requested due to automatic review settings February 9, 2026 20:15

Copilot AI reviewed Feb 9, 2026

View reviewed changes

alexander-yevsyukov added 3 commits February 9, 2026 20:46

Improve regex patterns and docs

1df5d08

Improve regex patterns and docs

e31ae89

Fix the reference to the clean task

ca5f681

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs set 1 #261

Docs set 1 #261

Uh oh!

alexander-yevsyukov commented Jan 20, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 22, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 5, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 5, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

	- [Target Audience](target-audience.md)
	- [Target audience](target-audience.md)

	// Must be present and contain at least 4 Latin letters or spaces.
	// Must be present, contain at least 4 characters, start and end with a Latin letter,
	// and may contain spaces between words.

	If you add another example proejct, please remember to update
	If you add another example project, please remember to update

Docs set 1 #261

Are you sure you want to change the base?

Docs set 1 #261

Uh oh!

Conversation

alexander-yevsyukov commented Jan 20, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 22, 2026

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!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 5, 2026

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!

Copilot AI Feb 5, 2026

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!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant