Document custom options#292
Conversation
Bumps [postcss](https://github.com/postcss/postcss) from 8.5.6 to 8.5.10. - [Release notes](https://github.com/postcss/postcss/releases) - [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md) - [Commits](postcss/postcss@8.5.6...8.5.10) --- updated-dependencies: - dependency-name: postcss dependency-version: 8.5.10 dependency-type: direct:development ... Signed-off-by: dependabot[bot] <support@github.com>
…eview/postcss-8.5.10' into document-custom-options
There was a problem hiding this comment.
Pull request overview
Updates the project’s published version and aligns related build/documentation metadata, while introducing a Time-related documentation dependency and submodule.
Changes:
- Bump Validation SDK and related dependency versions across Gradle, Maven POM output, and docs.
- Add
time-validationas a dependency and exposetime-validation/time-gradle-plugincoordinates inbuildSrc. - Add a new docs
_timeGit submodule and ignore Junie memory output.
Reviewed changes
Copilot reviewed 14 out of 15 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| version.gradle.kts | Bumps the published Validation SDK version to 2.0.0-SNAPSHOT.415. |
| pom.xml | Updates generated first-level dependency versions and adds io.spine.tools:time-validation. |
| docs/content/docs/validation/01-getting-started/adding-to-build.md | Updates example plugin versions referenced in docs. |
| dependencies.md | Refreshes generated dependency/license report for the new version. |
| buildSrc/src/main/kotlin/io/spine/dependency/local/Validation.kt | Bumps the pinned Validation artifacts version used by build logic. |
| buildSrc/src/main/kotlin/io/spine/dependency/local/Time.kt | Bumps Time version and adds helpers for time-validation and time-gradle-plugin. |
| buildSrc/src/main/kotlin/io/spine/dependency/local/CoreJvmCompiler.kt | Bumps Core JVM compiler “dogfooding” version. |
| buildSrc/src/main/kotlin/io/spine/dependency/build/Dokka.kt | Removes an unused import. |
| buildSrc/build.gradle.kts | Removes outdated Shadow plugin compatibility note. |
| .junie/guidelines.md | Generalizes Junie guidance wording to “Spine family of projects”. |
| .gitmodules | Adds docs/_time submodule pointing to SpineEventEngine/time. |
| .gitignore | Ignores .junie/memory/. |
Comments suppressed due to low confidence (1)
buildSrc/src/main/kotlin/io/spine/dependency/local/Time.kt:73
Timenow exposesvalidationandgradlePluginartifact coordinates, but they are not included inmodules. SincemodulesdrivesDependency.artifacts/forceArtifacts(), this makes the dependency metadata incomplete and can lead to these new artifacts not being version-forced whenTimeis used that way. Add the new artifacts tomodules(or document why they are intentionally excluded).
fun validation(version: String): String = "${Spine.toolsGroup}:time-validation:$version"
val validation get() = validation(version)
fun gradlePlugin(version: String): String = "${Spine.toolsGroup}:time-gradle-plugin:$version"
val gradlePlugin get() = gradlePlugin(version)
override val modules: List<String>
get() = listOf(
lib,
javaExtensions,
kotlinExtensions,
testLib
).map {
it.split(":").let { (g, artifact) -> "$g:$artifact" }
}
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: a8230b8bf9
ℹ️ 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".
There was a problem hiding this comment.
Pull request overview
This PR restructures and expands the Validation documentation around “Custom validation” into a multi-page workflow, and updates build/docs metadata to newer snapshot versions.
Changes:
- Replace the single “Custom validation” page with a new multi-page
05-custom-validation/section and update all internal links/navigation accordingly. - Bump published snapshot versions across Gradle/Maven/docs examples, plus update some dependency pins (e.g.,
postcss). - Add the Spine Time repository as a docs submodule (
docs/_time) and extend local dependency helpers for Time.
Reviewed changes
Copilot reviewed 43 out of 46 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| version.gradle.kts | Bumps Validation publish version to .415. |
| pom.xml | Updates generated POM versions/deps; adds time-validation dependency. |
| docs/data/docs/validation/2-0-0-snapshot/sidenav.yml | Reworks nav: “Custom validation” becomes a multi-page section. |
| docs/content/docs/validation/_index.md | Updates root docs link to new custom validation path. |
| docs/content/docs/validation/09-developers-guide/key-modules.md | Updates link to new custom validation path. |
| docs/content/docs/validation/09-developers-guide/architecture.md | Updates link to new custom validation path. |
| docs/content/docs/validation/08-custom-validation/_index.md | Removes old single-page custom validation doc. |
| docs/content/docs/validation/05-custom-validation/_index.md | Adds new “Overview” page for custom validation section. |
| docs/content/docs/validation/05-custom-validation/declare-the-option.md | Adds step: declaring a custom option in Protobuf. |
| docs/content/docs/validation/05-custom-validation/register-the-option.md | Adds step: registering proto extension + ValidationOption. |
| docs/content/docs/validation/05-custom-validation/declare-event-and-view.md | Adds step: define discovery event and view state. |
| docs/content/docs/validation/05-custom-validation/implement-the-reaction.md | Adds step: implement Reaction for the option. |
| docs/content/docs/validation/05-custom-validation/implement-the-view.md | Adds step: implement View projection. |
| docs/content/docs/validation/05-custom-validation/implement-the-generator.md | Adds step: implement generator and querying pattern. |
| docs/content/docs/validation/05-custom-validation/pass-to-compiler.md | Adds step: place option implementation on compiler classpath. |
| docs/content/docs/validation/05-custom-validation/summary.md | Adds recap page for the workflow. |
| docs/content/docs/validation/04-validators/implement-a-validator.md | Updates “What’s next” link to new custom validation path. |
| docs/content/docs/validation/04-validators/_index.md | Updates references to new custom validation path. |
| docs/content/docs/validation/03-built-in-options/_index.md | Updates “What’s next” link to new custom validation path. |
| docs/content/docs/validation/02-concepts/options-overview.md | Minor wording/formatting + updates custom validation link. |
| docs/content/docs/validation/02-concepts/error-messages.md | Updates custom validation link. |
| docs/content/docs/validation/02-concepts/_index.md | Minor wording/formatting + updates custom validation link. |
| docs/content/docs/validation/01-getting-started/generated-code.md | Updates custom validation link. |
| docs/content/docs/validation/01-getting-started/adding-to-build.md | Updates plugin version examples (validation / core-jvm). |
| docs/_preview/package.json | Bumps postcss dev dependency. |
| docs/_preview/package-lock.json | Lockfile update for postcss. |
| dependencies.md | Regenerates dependency/license report for .415. |
| buildSrc/src/main/kotlin/io/spine/dependency/local/Validation.kt | Bumps local Validation dependency version constant. |
| buildSrc/src/main/kotlin/io/spine/dependency/local/Time.kt | Bumps Time version; adds time-validation and Time Gradle plugin aliases. |
| buildSrc/src/main/kotlin/io/spine/dependency/local/CoreJvmCompiler.kt | Bumps CoreJvm compiler plugin versions. |
| buildSrc/src/main/kotlin/io/spine/dependency/build/Dokka.kt | Removes an unused import. |
| buildSrc/build.gradle.kts | Removes outdated Shadow plugin compatibility comment. |
| .junie/guidelines.md | Updates Junie guidelines wording. |
| .gitmodules | Adds docs/_time submodule pointing to Spine Time repo. |
| .gitignore | Ignores .junie/memory/. |
| .agents/skills/writer/agents/openai.yaml | Updates writer agent prompt (nav sync + footnote-link preference). |
| .agents/skills/writer/SKILL.md | Expands writer skill guidance (nav sync + link style). |
Files not reviewed (1)
- docs/_preview/package-lock.json: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
armiol
left a comment
There was a problem hiding this comment.
@alexander-yevsyukov LGTM in general. Please see one comment and one suggestion.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 45 out of 48 changed files in this pull request and generated 5 comments.
Files not reviewed (1)
- docs/_preview/package-lock.json: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Also: * Apply minor fixes.
This PR extends the documentation with detailed text in the "Custom validation" section.
Other notable changes
writerskill was improved to update the navigation bar when content changes and use footnote-like links in Markdown.