Skip to content

Conversation

@alexander-yevsyukov
Copy link
Collaborator

@alexander-yevsyukov alexander-yevsyukov commented Nov 27, 2025

This PR applies the latest config thus brining improvements to the documentation build scripts.

Other notable changes

  • Fixed references to Spine Compiler in the docs.
  • Drafted docs folder.
  • Patched LicenseReporter to ignore missing files.

Copilot AI review requested due to automatic review settings November 27, 2025 19:55
@alexander-yevsyukov alexander-yevsyukov self-assigned this Nov 27, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR restructures documentation and updates dependencies across the project. The changes include creating a new documentation structure with comprehensive guides, updating Gradle wrapper to 9.2.1, upgrading various dependencies (Protobuf, Kotlin, JUnit, etc.), and refactoring build configuration to use the new io.spine.generated-sources plugin and updated Dokka setup.

Key Changes

  • Documentation restructured into a comprehensive multi-section guide with Table of Contents
  • Gradle wrapper upgraded from 9.1.0 to 9.2.1
  • Major dependency updates (Kotlin 2.2.21, Protobuf 4.33.1, JUnit 6.0.0, etc.)
  • Build configuration refactored to use new Dokka 2.1.0 setup and io.spine.generated-sources plugin

Reviewed changes

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

Show a summary per file
File Description
docs/ToC.md New comprehensive documentation table of contents structure
docs/00-intro/*.md New introduction section with overview, target audience, and philosophy
docs/01-getting-started/index.md New getting started guide
docs/developers-guide/*.md New developer-focused documentation on architecture and modules
docs/adding-custom-validataion.md New guide for adding custom validation
gradle/wrapper/gradle-wrapper.properties Gradle version bump to 9.2.1
buildSrc/src/main/kotlin/io/spine/dependency/**/*.kt Dependency version updates and refactoring
buildSrc/src/main/kotlin/**/*.gradle.kts Build script updates for new Dokka and plugin configuration
java-runtime/build.gradle.kts Migration to io.spine.generated-sources plugin
Various buildSrc files Removal of deprecated code and simplification of publishing configuration
Comments suppressed due to low confidence (2)

docs/adding-custom-validataion.md:1

  • Corrected spelling of 'validataion' to 'validation' in the filename.
    buildSrc/src/main/kotlin/io/spine/gradle/repo/RepoSlug.kt:1
  • The SSH host alias changed from github.com-publish to github-publish, but this may break existing SSH configurations. Ensure the corresponding SSH config in SshKey.kt (lines 113-116) is consistently used everywhere, and verify that CI/CD systems have been updated to match this change.

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

Copilot AI review requested due to automatic review settings November 28, 2025 22:39
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

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

Comments suppressed due to low confidence (3)

docs/adding-custom-validataion.md:1

  • Corrected spelling of 'validataion' to 'validation' in filename.
    gradlew:1
  • The copyright year range was changed from '2015-2021' to just '2015'. If this is intentional to reflect the last modification year, it should be '2015-2025' to include the current year. Otherwise, the previous range '2015-2021' was more accurate.
    buildSrc/src/main/kotlin/io/spine/gradle/git/Repository.kt:1
  • Using logger.error() for informational command execution messages is incorrect. This should use logger.debug() or logger.info() as these are diagnostic messages, not errors.

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

Copilot AI review requested due to automatic review settings December 2, 2025 19:28
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@alexander-yevsyukov alexander-yevsyukov changed the title Draft doc structure Apply latest config and local dependencies Dec 3, 2025
@alexander-yevsyukov alexander-yevsyukov marked this pull request as ready for review December 3, 2025 17:39
@chatgpt-codex-connector
Copy link

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

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

Comments suppressed due to low confidence (5)

pom.xml:1

  • JUnit 6.0.0 does not exist. The latest stable version of JUnit 5 (Jupiter) is 5.11.x. Please verify this version or use a valid JUnit version.
    docs/adding-custom-validataion.md:1
  • Corrected spelling of 'validataion' to 'validation' in filename.
    buildSrc/src/main/kotlin/io/spine/gradle/report/license/LicenseReporter.kt:1
  • Add a comment explaining why files are filtered for existence, as mentioned in the PR description that LicenseReporter was patched to ignore missing files.
    buildSrc/src/main/kotlin/io/spine/gradle/github/pages/UpdateGitHubPages.kt:1
  • The TODO date '2025-11-20' is in the future relative to the current date (December 3, 2025). This appears to be a past date that should be in the past tense or the date may be incorrect.
    buildSrc/src/main/kotlin/io/spine/gradle/repo/RepoSlug.kt:1
  • Removed incorrect reference in SSH host from 'github.com-publish' to 'github-publish'.

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

Copy link
Collaborator

@armiol armiol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alexander-yevsyukov as discussed, let's also update the part related to REPO_SLUG.

@alexander-yevsyukov alexander-yevsyukov merged commit 0aeca62 into master Dec 3, 2025
6 of 9 checks passed
@alexander-yevsyukov alexander-yevsyukov deleted the draft-doc-structure branch December 3, 2025 19:39
@codecov
Copy link

codecov bot commented Dec 3, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 34.91%. Comparing base (0f3f1ec) to head (f1ce3bf).
⚠️ Report is 27 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff              @@
##             master     #239      +/-   ##
============================================
+ Coverage     34.47%   34.91%   +0.44%     
  Complexity      282      282              
============================================
  Files           136      136              
  Lines          3231     3070     -161     
  Branches        247      247              
============================================
- Hits           1114     1072      -42     
+ Misses         2040     1921     -119     
  Partials         77       77              
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants