Skip to content

Improve README.md, fix coverage reports, add Java warning suppression DSL#313

Merged
alexander-yevsyukov merged 28 commits into
masterfrom
improve-readme
May 28, 2026
Merged

Improve README.md, fix coverage reports, add Java warning suppression DSL#313
alexander-yevsyukov merged 28 commits into
masterfrom
improve-readme

Conversation

@alexander-yevsyukov

@alexander-yevsyukov alexander-yevsyukov commented May 27, 2026

Copy link
Copy Markdown
Collaborator

This PR updates README.md addressing #56 and #283.

Java renderer settings

  • Added JavaValidationRendererSettings proto as the typed envelope for
    settings consumed by JavaValidationRenderer. It carries a
    SuppressWarnings suppress_warnings field.
  • Renamed the previous ValidationWarnings proto to SuppressWarnings.
    The unsigned_fields = true flag now suppresses the
    "Unsigned integer types are not supported in Java" warning emitted for
    uint32/uint64 fields constrained by (range), (min), or (max).
    The proto3 default false keeps warnings emitted.
  • Added the DSL block on ValidationExtension:
    spine {
        validation {
            java {
                suppressWarnings {
                    unsignedFields.set(true)
                }
            }
        }
    }
    Default: no warnings suppressed.
  • ValidationGradlePlugin writes the settings file in
    LaunchSpineCompiler.doFirst, not in afterEvaluate, so that a preceding
    clean task cannot delete the file before the compiler subprocess reads
    the settings directory.
  • Settings are written in ProtoJson format instead of ProtoBinary, so an
    explicit false value is preserved on disk (proto3 omits defaults from
    the binary wire format).

Other notable changes

  • Fixed generation of coverage reports and addressed Codecov settings
    deprecations.
  • Latest config was applied.
  • Improved scripts related to agent skills.

Copilot AI review requested due to automatic review settings May 27, 2026 18:03
@alexander-yevsyukov alexander-yevsyukov self-assigned this May 27, 2026
@alexander-yevsyukov alexander-yevsyukov marked this pull request as ready for review May 27, 2026 18:04

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: e2d7cd72a7

ℹ️ 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".

Comment thread .github/workflows/check-links.yml

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 refreshes the repository’s public-facing README (per #56 / #283) and applies a broader config/tooling update across docs, CI, coverage reporting, and agent instructions.

Changes:

  • Expanded README.md with a fuller overview, quick-start, and links to spine.io documentation.
  • Updated version references to 2.0.0-SNAPSHOT.444 across Gradle + docs dependency artifacts.
  • Adjusted CI/docs tooling: JaCoCo aggregation timing, Codecov upload settings, and link-check workflow generalized for docs/ or site/.

Reviewed changes

Copilot reviewed 36 out of 41 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
version.gradle.kts Bumps published snapshot version.
README.md Rewrites README with overview, TOC, examples, and spine.io doc links.
docs/dependencies/pom.xml Updates docs dependency POM version.
docs/dependencies/dependencies.md Regenerated dependency/license report for new version.
docs/content/docs/validation/user/01-getting-started/adding-to-build.md Updates plugin version in docs snippet.
docs/content/docs/validation/developer/build-and-release.md Updates version example in release docs.
CLAUDE.md Converts to thin wrapper referencing AGENTS.md plus Claude-specific notes.
buildSrc/src/main/kotlin/io/spine/gradle/report/coverage/JacocoConfig.kt Adjusts JaCoCo aggregation setup and ensures tests run before report tasks.
AGENTS.md Consolidates universal agent guidance into a single entrypoint.
.idea/misc.xml IntelliJ project metadata adjustments.
.idea/live-templates/User.xml Fixes live-template date format pattern.
.idea/live-templates/README.md Corrects spelling/whitespace in live templates documentation.
.gitignore Updates ignores for docs preview site artifacts.
.github/workflows/check-links.yml Generalizes link-check workflow to auto-detect docs/ vs site/ Hugo roots.
.github/workflows/build-on-ubuntu.yml Updates Codecov upload configuration to point at aggregated JaCoCo XML.
.github/copilot-instructions.md Adds repo-specific Copilot instruction entrypoint referencing AGENTS.md.
.codecov.yml Updates Codecov settings (including deprecation-related changes).
.claude/settings.json Updates Claude Code permissions and hook configuration.
.agents/tasks/setup-cross-tool-agent-instructions.md Adds task doc describing agent-instruction consolidation work.
.agents/tasks/reject-required-on-empty.md Removes completed/outdated task plan.
.agents/tasks/prompt-caching-org.md Adds task doc about org-level prompt caching strategy.
.agents/tasks/issue-175-set-once-timestamp.md Removes completed/outdated task plan.
.agents/tasks/check-links.md Removes completed/outdated task plan.
.agents/skills/pre-pr/SKILL.md Updates pre-PR orchestration guidance and sentinel contract.
.agents/skills/check-links/SKILL.md Updates check-links skill to support docs/ or site/ layouts.
.agents/scripts/sanitize-source-code.sh Tweaks hook behavior around jq presence.
.agents/scripts/publish-version-gate.sh Tweaks hook behavior around jq presence.
.agents/scripts/protect-version-file.sh Tweaks hook behavior around jq presence.
.agents/scripts/pre-pr-gate.sh Tweaks hook behavior around jq presence.
.agents/quick-reference-card.md Updates condensed safety guidance wording.
.agents/project.template.md Adds template for repo-specific .agents/project.md.
.agents/project.md Adds .agents/project.md file (currently template content).
.agents/project-overview.md Removes prior project overview doc.
.agents/memory/reference/cache-warm-window.md Adds reference memory about cache warm windows.
.agents/memory/reference/anthropic-api-caching.md Adds reference memory about Anthropic API caching patterns.
.agents/memory/MEMORY.md Updates memory index to include new entries.
.agents/memory/feedback/copilot-review-request.md Adds feedback memory about requesting Copilot reviews programmatically.
.agents/jvm-project.md Adds JVM-wide requirements/checklist doc.
.agents/_TOC.md Updates TOC links (replacing project overview with JVM requirements).
Files not reviewed (3)
  • .idea/live-templates/README.md: Language not supported
  • .idea/live-templates/User.xml: Language not supported
  • .idea/misc.xml: Language not supported

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

Comment thread .agents/project.md Outdated
Comment thread .claude/settings.json
Comment thread .agents/scripts/protect-version-file.sh Outdated
Comment thread .agents/scripts/pre-pr-gate.sh Outdated
Comment thread .agents/scripts/publish-version-gate.sh
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings May 27, 2026 18:10
alexander-yevsyukov and others added 4 commits May 27, 2026 21:11
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 36 out of 41 changed files in this pull request and generated 4 comments.

Files not reviewed (3)
  • .idea/live-templates/README.md: Language not supported
  • .idea/live-templates/User.xml: Language not supported
  • .idea/misc.xml: Language not supported

Comment thread .claude/settings.json
Comment thread .agents/skills/check-links/SKILL.md
Comment thread .github/workflows/check-links.yml
Comment thread .agents/skills/check-links/SKILL.md
@codecov

codecov Bot commented May 27, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 33.33333% with 12 lines in your changes missing coverage. Please review.
⚠️ Please upload report for BASE (master@dd65da5). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff            @@
##             master    #313   +/-   ##
========================================
  Coverage          ?   9.53%           
  Complexity        ?      62           
========================================
  Files             ?      82           
  Lines             ?    2034           
  Branches          ?     160           
========================================
  Hits              ?     194           
  Misses            ?    1834           
  Partials          ?       6           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@alexander-yevsyukov alexander-yevsyukov changed the title Improve readme Improve README.md, fix code coverage reports May 27, 2026
Copilot AI review requested due to automatic review settings May 27, 2026 22:00

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 44 out of 51 changed files in this pull request and generated 3 comments.

Files not reviewed (3)
  • .idea/live-templates/README.md: Language not supported
  • .idea/live-templates/User.xml: Language not supported
  • .idea/misc.xml: Language not supported

Comment thread tests/validating/build.gradle.kts
Comment thread tests/runtime/build.gradle.kts
@alexander-yevsyukov alexander-yevsyukov changed the title Improve README.md, fix code coverage reports Improve README.md, fix coverage reports, add Java warning suppression DSL May 28, 2026
@alexander-yevsyukov

Copy link
Copy Markdown
Collaborator Author

@armiol, two commented out blocks in build.gradle.kts files were left intentionally for easy recovery in the next PR.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 53 out of 60 changed files in this pull request and generated 6 comments.

Files not reviewed (3)
  • .idea/live-templates/README.md: Language not supported
  • .idea/live-templates/User.xml: Language not supported
  • .idea/misc.xml: Language not supported

Comment thread tests/runtime/build.gradle.kts
Comment thread tests/validating/build.gradle.kts
Comment thread .agents/scripts/publish-version-gate.sh
Comment thread tests/runtime/build.gradle.kts
Comment thread tests/validating/build.gradle.kts
Copilot AI review requested due to automatic review settings May 28, 2026 15:45

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 53 out of 60 changed files in this pull request and generated 2 comments.

Files not reviewed (3)
  • .idea/live-templates/README.md: Language not supported
  • .idea/live-templates/User.xml: Language not supported
  • .idea/misc.xml: Language not supported
Comments suppressed due to low confidence (1)

java-settings/src/main/proto/spine/validation/java/java_validation_renderer_settings.proto:64

  • The proto message name SuppressWarnings generates a Java class io.spine.tools.validation.settings.SuppressWarnings, which is easy to confuse with (and can shadow) the standard Java @SuppressWarnings annotation when imported. Consider renaming this message to something more specific (e.g. WarningSuppression / JavaWarningSuppression) to avoid import/name collisions for Java consumers of the settings API.

Comment thread tests/runtime/build.gradle.kts
Comment thread tests/validating/build.gradle.kts
@alexander-yevsyukov alexander-yevsyukov merged commit 1918b8f into master May 28, 2026
10 of 12 checks passed
@alexander-yevsyukov alexander-yevsyukov deleted the improve-readme branch May 28, 2026 15:56
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