nchammas opened a new pull request, #57015:
URL: https://github.com/apache/spark/pull/57015

   ### What changes were proposed in this pull request?
   
   1. Use a GitHub Actions [problem matcher][pm] to simplify how we surface doc 
errors on PRs and eliminate the need for custom logic in our documentation 
build script for this purpose.
   
   [pm]: https://github.com/actions/toolkit/blob/main/docs/problem-matchers.md
   
   2. Remove the `-verbose` option from `JavaUnidoc / unidoc / javacOptions`, 
which is no longer needed.
   
   3. Add `lintUnusedKeysOnLoad` to the build to suppress annoying sbt warning 
that I believe no-one cares about. (This could have been captured in a simpler 
`build.sbt`, but it seems the project's convention is to not have those.)
   
   ### Why are the changes needed?
   
   In general, we should strive to minimize the amount of Ruby code we maintain 
since it's not a core competency of the project. In this particular case, I 
believe we can specifically use declarative GitHub Actions [problem 
matchers][pm] to accomplish our goal without needing to write or maintain 
custom log filtering logic.
   
   `-verbose` was added in #55605 and #55814 to surface doclint errors, along 
with filters to cut down the unwanted extra noise. However, the same PRs also 
added `-Xmaxerrs 0`, which independently fixes the same problem of surfacing 
doc errors, regardless of `-verbose`.
   
   With `-verbose` gone, the log drops from ~16K lines to ~1K, making the 
remaining noise a minor nuisance rather than worth a complex filter.
   
   ### Does this PR introduce _any_ user-facing change?
   
   No.
   
   ### How was this patch tested?
   
   This PR and its associated CI runs will serve as tests.
   
   TODO:
   - [ ] Validate that the problem matchers surface the desired log entries.
   
   ### Was this patch authored or co-authored using generative AI tooling?
   
   Co-authored with assistance from GitHub Copilot.
   


-- 
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: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to