Skip to content

Enable Github Actions for Checkstyle #438

Closed
@SteveYurongSu

Description

Enhancement Request

Is your enhancement request related to a problem? Please describe

I noticed that there are folks working on issue #428 (#431), translating or removing Chinese chars in code.
Manually checking for this kind of code style can be a pain.
But, we can make the process of code style check automated with less pain by introducing Checkstyle into CI.

Describe the solution you'd like

I'd like to define a Checkstyle workflow in CI.
The Checkstyle workflow will fail if a bad code style is found and will provide a report after each run.
The report includes the code style issues found in the workflow, and it can be a reference for reviewers.

Describe alternatives you've considered

  • Github Actions: Checkstyle check + reviewdog report
  • Github Actions: Spotless check

Additional context

reviewdog: https://github.com/reviewdog/reviewdog
checkstyle-idea: https://plugins.jetbrains.com/plugin/1065-checkstyle-idea

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions