You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "gnodet (via GitHub)" <gi...@apache.org> on 2026/10/16 09:19:01 UTC

[I] Add `reportVersion` field to `build-report.json` [maven]

gnodet opened a new issue, #13564:
URL: https://github.com/apache/maven/issues/13564

   ## Problem
   
   The `build-report.json` format introduced in PR #12695 has no version field.
   External tools (rtk, IDE integrations, LLM agents, build scanners) will consume
   this file. As the format evolves (new fields, changed semantics), consumers need
   a way to detect which version of the schema they're reading.
   
   ## Proposed fix
   
   Add `"reportVersion": "1.0"` as the first field in the JSON output.
   
   Versioning policy:
   - **Minor bump** (1.0 → 1.1) for additive changes (new optional fields)
   - **Major bump** (1.x → 2.0) for breaking changes (removed/renamed fields,
     changed semantics)
   
   ### Changes needed
   
   - Add `reportVersion()` method to `BuildReport` interface
   - Update `BuildReportJsonWriter` to emit `reportVersion` as the first field
   - Update `DefaultBuildReport` to include the version
   - Update `SimpleJsonReader` / `BuildReportRenderer` to read and display it
   
   ## Related
   
   - #12695 — Build report PR
   - #12571 — Build output overhaul tracking issue
   
   <!-- AI-Agent-Disclosure -->
   > 🤖 Drafted with Claude Code (Claude Opus 4.6). Reviewed and confirmed by @gnodet before submission.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] Add `reportVersion` field to `build-report.json` [maven]

Posted by "codewithsinchana (via GitHub) via issues" <is...@maven.apache.org>.
codewithsinchana commented on issue #13564:
URL: https://github.com/apache/maven/issues/13564#issuecomment-6827465969

   Hi Guillaume, I checked the `feature/build-report` branch and found that commit `4d4ccfbde8` already adds the `reportVersion` field, including the API method, JSON writer, default implementation, and a writer test. I couldn't find the `SimpleJsonReader` or `BuildReportRenderer` classes mentioned in the issue. Is there any remaining part of this issue that would be useful for me to work on?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] Add `reportVersion` field to `build-report.json` [maven]

Posted by "codewithsinchana (via GitHub)" <gi...@apache.org>.
codewithsinchana commented on issue #13564:
URL: https://github.com/apache/maven/issues/13564#issuecomment-6444708061

   Hi Guillaume, I'd like to contribute to this issue. I can work on adding the `reportVersion` field, updating the reader and renderer, and adding the corresponding tests. Is this still available to work on?
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org