Re-enable check style Maven Plugin (SZ-16)
rk@tigase.net opened 1 week ago

Description

The current Maven build is failing due to the absence of the required Checkstyle configuration file:

[ERROR] Failed during checkstyle execution: Unable to find configuration file at location: checkstyle.xml

To unblock the MVP build and allow ongoing development, the Checkstyle plugin will be temporarily skipped using:

mvn clean install -Dcheckstyle.skip=true

This issue tracks the task of re-enabling Checkstyle after the MVP milestone, restoring code style enforcement across the codebase.


Acceptance Criteria

  •  Add or restore a checkstyle.xml file at the project root or in a shared config location.
  •  Configure maven-checkstyle-plugin in the pom.xml to reference the config file.
  •  Ensure mvn clean install passes without needing to skip Checkstyle.
  •  Optionally integrate Checkstyle validation into CI (GitHub Actions, OneDev, etc.).
  •  Document the Checkstyle rules and formatting guidelines in CONTRIBUTING.md.

Notes

  • We can use the Google Java Style Guide or Spring Java Format as the base style.
  • Shall we use a shared ruleset across all Tigase Java projects?
  • IntelliJ (I assume we all use IDEAj) formatting can be aligned with Checkstyle via plugins or formatter configs.

Target Milestone

Post-MVP Cleanup / Developer Quality Enhancements


Severity

Low (non-blocking, build workaround available)


  • rk@tigase.net commented 1 week ago

    ⏱️ Estimated Time

    TaskTime Estimate
    Add or restore checkstyle.xml30 mins
    Configure plugin in pom.xml15 mins
    Verify build without -Dcheckstyle.skip15 mins
    CI integration (optional)30 mins
    Update CONTRIBUTING.md (optional)20 mins
    Total Estimate1.5–2 hrs
  • rk@tigase.net changed title 3 days ago
    Previous Value Current Value
    Re-enable check sty;e Maven Plugin
    Re-enable check style Maven Plugin
issue 1 of 1
Type
Bug
Priority
Normal
Assignee
Version
none
Sprints
n/a
Customer
n/a
Issue Votes (0)
Watchers (3)
Reference
SZ-16
Please wait...
Page is in error, reload to recover