Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature Request][INFRA] Improve the java checkstyle checks to log the errors to the sbt console #3067

Closed
4 of 8 tasks
allisonport-db opened this issue May 8, 2024 · 0 comments · Fixed by #3115
Closed
4 of 8 tasks
Labels
enhancement New feature or request

Comments

@allisonport-db
Copy link
Collaborator

Feature request

Which Delta project/connector is this regarding?

  • Spark
  • Standalone
  • Flink
  • Kernel
  • Other (fill in here)

Overview

When we upgraded our sbt version we were forced to upgrade our the sbt java checkstyle plug in #3019. This upgrade means that the java checkstyle errors are no longer logged to the sbt console. Fixing errors requires looking at the $projectName/target/checkstyle-report.xml and $projectName/target/checkstyle-test-report.xml. This is a poor dev workflow, and much inferior to the previous state where the errors would be printed to the console.

Further details

We can add our own reading of the checkstyle reports and logging to console as part of our sbt build. For inspiration, we can look at the code that was used in the former sbt checkstyle plugin here https://github.com/etsy/sbt-checkstyle-plugin/blob/master/src/main/scala/com/etsy/sbt/checkstyle/Checkstyle.scala#L70-L97

Willingness to contribute

The Delta Lake Community encourages new feature contributions. Would you or another member of your organization be willing to contribute an implementation of this feature?

  • Yes. I can contribute this feature independently.
  • Yes. I would be willing to contribute this feature with guidance from the Delta Lake community.
  • No. I cannot contribute this feature at this time.
@allisonport-db allisonport-db added the enhancement New feature or request label May 8, 2024
vkorukanti pushed a commit that referenced this issue May 22, 2024
…3115)

## Description
Resolves #3067.

## How was this patch tested?
On local machine, intentionally create checkstyle errors in module
`kernelDefaults` (for experimental), then run the `build/sbt compile`
and `build/sbt kernelDefaults/test`.

Signed-off-by: Tai Le Manh <manhtai.lmt@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant