[MCHECKSTYLE-406] Make plugin compatible with Checkstyle 8.44 (Upgraded to 9.1)

• Type: Dependency upgrade
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 3.1.2
• Fix Version/s: 3.2.0
• Assignee: Sylwester Lachiewicz
• Reporter: Alexander Kriegisch
• Created: 06/Jul/21 07:25
• Updated: 30/Nov/21 01:38
• Resolved: 21/Nov/21 09:59

Description

On GitHub, Dependabot suggests upgrading Checkstyle to something more recent than 8.41.1, but the corresponding builds fail, both for 8.43 and 8.44, e.g. this build:

Error:  Failed to execute goal org.apache.maven.plugins:maven-site-plugin:3.9.1:site (default-site) on project aspectj-maven-plugin: Error generating maven-checkstyle-plugin:3.1.2:checkstyle report: Failed during checkstyle configuration: cannot initialize module TreeWalker - cannot initialize module JavadocMethod - Property 'scope' does not exist, please check the documentation -> [Help 1]
org.apache.maven.lifecycle.LifecycleExecutionException: Failed to execute goal org.apache.maven.plugins:maven-site-plugin:3.9.1:site (default-site) on project aspectj-maven-plugin: Error generating maven-checkstyle-plugin:3.1.2:checkstyle report
    at org.apache.maven.lifecycle.internal.MojoExecutor.execute (MojoExecutor.java:215)
    at org.apache.maven.lifecycle.internal.MojoExecutor.execute (MojoExecutor.java:156)
    at org.apache.maven.lifecycle.internal.MojoExecutor.execute (MojoExecutor.java:148)
    (...)
Caused by: org.apache.maven.plugin.MojoExecutionException: Error generating maven-checkstyle-plugin:3.1.2:checkstyle report
    at org.apache.maven.plugins.site.render.SiteMojo.execute (SiteMojo.java:151)
    at org.apache.maven.plugin.DefaultBuildPluginManager.executeMojo (DefaultBuildPluginManager.java:137)
    at org.apache.maven.lifecycle.internal.MojoExecutor.execute (MojoExecutor.java:210)
    (...)
Caused by: org.apache.maven.reporting.MavenReportException: Failed during checkstyle configuration
    at com.puppycrawl.tools.checkstyle.api.AutomaticBean.configure (AutomaticBean.java:201)
    at org.apache.maven.plugins.checkstyle.exec.DefaultCheckstyleExecutor.executeCheckstyle (DefaultCheckstyleExecutor.java:167)
    at org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport.executeReport (AbstractCheckstyleReport.java:533)
    (...)

This is in no way urgent, but as Dependabot keeps bugging me with this for every new Checkstyle version, I thought I should mention it.

Issue Links

• is blocked by: MSHARED-990 Checkstyle config: Swap scope and exclude scope to access modifier in the check JavadocMethodCheck.
• is duplicated by: MCHECKSTYLE-404 maven-checkstyle-plugin version 3.1.2 Old version of checkstyle detected. Consider updating to >= v8.30