phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[compat6] Mark pmd-compat6 module as deprecated

Browse Source
This commit is contained in:
Andreas Dangel 2024-03-07 08:27:12 +01:00
parent daa741c817
commit a69068de2d
No known key found for this signature in database
GPG Key ID: 93450DF2DF9A3FA3
3 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/pages/release_notes.md
View File

@ -73,6 +73,14 @@ As PMD 7 revamped the Java module, if you have custom rules, you need to migrate
See the use case [I'm using custom rules]({{ baseurl }}pmd_userdocs_migrating_to_pmd7.html#im-using-custom-rules)
in the Migration Guide.
Note: Once the default version of PMD is upgraded to PMD7 in maven-pmd-plugin
(see [MPMD-379](https://issues.apache.org/jira/projects/MPMD/issues/MPMD-379)), this
compatibility module is no longer needed. The module pmd-compat6 might not be maintaned then
any further, hence it is already declared as deprecated.
No guarantee is given, that the (deprecated) module pmd-compat6 is being maintained over the
whole lifetime of PMD 7.
##### Java 22 Support
This release of PMD brings support for Java 22. There are the following new standard language features,

10
pmd-compat6/README.md
View File

@ -6,7 +6,7 @@ some removed methods.
The goal is, that PMD7 can be used with [Maven PMD Plugin](https://maven.apache.org/plugins/maven-pmd-plugin)
without any further changes to the plugin.
The plugin uses by default PMD Version 6.55.0, but it can be configured to
The maven-pmd-plugin uses by default PMD Version 6.55.0, but it can be configured to
[Use a new PMD version at runtime](https://maven.apache.org/plugins/maven-pmd-plugin/examples/upgrading-PMD-at-runtime.html).
Since PMD7 introduces many incompatible changes, another module is needed to restore
@ -27,9 +27,13 @@ It is as simple as adding:
Note: The dependency "pmd-compat6" must be listed _first_ before pmd-core, pmd-java, and the others.
Once the default version of PMD is upgraded to PMD7 in maven-pmd-plugin
Note: Once the default version of PMD is upgraded to PMD7 in maven-pmd-plugin
(see [MPMD-379](https://issues.apache.org/jira/projects/MPMD/issues/MPMD-379)), this
compatibility module is no longer needed.
compatibility module is no longer needed. The module pmd-compat6 might not be maintaned then
any further, hence it is already declared as deprecated.
The primary goal for this module is, to get maven-pmd-plugin working with PMD7. It might
be useful in other contexts, too, but no guarantee is given, that is works.
No guarantee is given, that the (deprecated) module pmd-compat6 is being maintained over the
whole lifetime of PMD 7.

2
pmd-compat6/pom.xml
View File

@ -11,7 +11,7 @@
</parent>
<artifactId>pmd-compat6</artifactId>
<name>PMD Compatibility Classes for PMD6</name>
<name>PMD Compatibility Classes for PMD6 (deprecated)</name>
<properties>
<pmd.version.for.integrationtest>${project.version}</pmd.version.for.integrationtest>