Add compatibility dashboards to the documentation site#461
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 2ec8510ed2
ℹ️ 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 adds “live” compatibility dashboards to the Maven documentation site by generating an aggregate compatibility summary from Failsafe reports and rendering it via Velocity-backed Markdown templates.
Changes:
- Convert
index.mdandcompatibility.mdinto Velocity templates (.md.vm) that render progress bars and per-test heatmaps from a generated XML summary. - Add CSS styles for compatibility progress bars, legends, and heatmaps.
- Introduce a Java-based generator to produce
compatibility-summary.xmlduring the site build, wired viaexec-maven-plugin.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
src/site/site.xml |
Renames the navigation item to “Compatibility and Compliance”. |
src/site/resources/css/site.css |
Adds styles for compatibility progress bars and heatmaps. |
src/site/markdown/index.md.vm |
New Velocity template homepage rendering compatibility summary bars. |
src/site/markdown/index.md |
Removes static homepage in favor of the Velocity template. |
src/site/markdown/compatibility.md.vm |
New Velocity template compatibility dashboard with per-test heatmaps. |
src/site/markdown/compatibility.md |
Removes static compatibility page in favor of the Velocity template. |
src/site/markdown/cli-reference.md |
Adds documentation about tuple serialization compatibility. |
src/site/java/io/jawk/site/CompatibilitySummaryGenerator.java |
Adds a generator that aggregates Failsafe XML into a site-consumable summary XML. |
pom.xml |
Adds an exec-maven-plugin execution intended to generate the summary XML before the site runs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 9 out of 9 changed files in this pull request and generated 8 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 9 out of 9 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 9 out of 9 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 9 out of 9 changed files in this pull request and generated 6 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 9 out of 9 changed files in this pull request and generated 6 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
bertysentry
deleted the
426-add-proper-reports-in-documentation-about-the-compatibility-tests
branch
Summary
Validation