Improve README.md, fix coverage reports, add Java warning suppression DSL#313
Conversation
Addresses issues: * 56 * #283
There was a problem hiding this comment.
💡 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".
There was a problem hiding this comment.
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.mdwith a fuller overview, quick-start, and links to spine.io documentation. - Updated version references to
2.0.0-SNAPSHOT.444across Gradle + docs dependency artifacts. - Adjusted CI/docs tooling: JaCoCo aggregation timing, Codecov upload settings, and link-check workflow generalized for
docs/orsite/.
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.
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>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
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
Codecov Report❌ Patch coverage is 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:
|
README.md, fix code coverage reports
There was a problem hiding this comment.
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
README.md, fix code coverage reportsREADME.md, fix coverage reports, add Java warning suppression DSL
|
@armiol, two commented out blocks in |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
SuppressWarningsgenerates a Java classio.spine.tools.validation.settings.SuppressWarnings, which is easy to confuse with (and can shadow) the standard Java@SuppressWarningsannotation 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.
This PR updates
README.mdaddressing #56 and #283.Java renderer settings
JavaValidationRendererSettingsproto as the typed envelope forsettings consumed by
JavaValidationRenderer. It carries aSuppressWarnings suppress_warningsfield.ValidationWarningsproto toSuppressWarnings.The
unsigned_fields = trueflag now suppresses the"Unsigned integer types are not supported in Java" warning emitted for
uint32/uint64fields constrained by(range),(min), or(max).The proto3 default
falsekeeps warnings emitted.ValidationExtension:spine { validation { java { suppressWarnings { unsignedFields.set(true) } } } }ValidationGradlePluginwrites the settings file inLaunchSpineCompiler.doFirst, not inafterEvaluate, so that a precedingcleantask cannot delete the file before the compiler subprocess readsthe settings directory.
ProtoJsonformat instead ofProtoBinary, so anexplicit
falsevalue is preserved on disk (proto3 omits defaults fromthe binary wire format).
Other notable changes
deprecations.
configwas applied.