[doc] Improve release notes, migration guide

This commit is contained in:
Andreas Dangel committed 2023-11-18 10:28:04 +01:00
1 parent 1e331f08b4
commit 4df11b35f1
2 files changed
+25 -7

No files matched your search

+13 -2
View File
@@ -3124,7 +3124,7 @@ This is only relevant, if you are maintaining a CPD language module for a custom
{% include note.html content="
When you switch from PMD 6.x to PMD 7 in your build tools, you most likely need to review your
ruleset(s) as well and check for removed rules.
See the use case[I'm using only built-in rules](#im-using-only-built-in-rules) above.
See the use case [I'm using only built-in rules](#im-using-only-built-in-rules) above.
" %}
#### Ant
@@ -3141,7 +3141,7 @@ See the use case[I'm using only built-in rules](#im-using-only-built-in-rules) a
* Due to some changes in PMD's API, you can't simply pull in the new PMD 7 dependency.
* However, there is now a compatibility module, that makes it possible to use PMD 7 with Maven. In addition to the PMD 7
dependencies documented in [Upgrading PMD at Runtime](https://maven.apache.org/plugins/maven-pmd-plugin/examples/upgrading-PMD-at-runtime.html)
you need to add additionally the following dependency (available with 7.0.0-rc4):
you need to add additionally the following dependency (first available version is 7.0.0-rc4):
```xml
<dependency>
@@ -3154,6 +3154,17 @@ See the use case[I'm using only built-in rules](#im-using-only-built-in-rules) a
It is important to add this dependency as the **first** in the list, so that maven-pmd-plugin sees the (old)
compatible versions of some classes.
This module is available beginning with version 7.0.0-rc4 and will be there at least for the first
final version PMD 7 (7.0.0). It's not decided yet, whether we will keep updating it, after PMD 7 is finally
released.
Note: This compatibility module only works for the built-in rules, that are still available in PMD 7. E.g. you need
to review your rulesets and look out for deprecated rules and such. See the use case
[I'm using only built-in rules](#im-using-only-built-in-rules)
As PMD 7 revamped the Java module, if you have custom rules, you need to migrate these rules.
See the use case [I'm using custom rules](#im-using-custom-rules).
#### Gradle
* Gradle uses internally PMD's Ant task to execute PMD
+12 -5
View File
@@ -60,11 +60,18 @@ compatibility module has been created. This allows to use PMD 7 by simply adding
It is important to add this dependency as the **first** in the list, so that maven-pmd-plugin sees the (old)
compatible versions of some classes.
Note: This compatibility modules only works for the built-in rules, that are still available in PMD 7 (you need
to review your rulesets).
As PMD 7 revamped the Java module, if you have custom rules, you need to migrate the rules.
For more information, see the [Detailed Release Notes for PMD 7]({{ baseurl }}pmd_release_notes_pmd7.html#revamped-java)
and [Migration Guide for PMD 7]({{ baseurl }}pmd_userdocs_migrating_to_pmd7.html).
This module is available beginning with version 7.0.0-rc4 and will be there at least for the first
final version PMD 7 (7.0.0). It's not decided yet, whether we will keep updating it, after PMD 7 is finally
released.
Note: This compatibility module only works for the built-in rules, that are still available in PMD 7. E.g. you need
to review your rulesets and look out for deprecated rules and such. See the use case
[I'm using only built-in rules]({{ baseurl }}pmd_userdocs_migrating_to_pmd7.html#im-using-only-built-in-rules)
in the [Migration Guide for PMD 7]({{ baseurl }}pmd_userdocs_migrating_to_pmd7.html).
As PMD 7 revamped the Java module, if you have custom rules, you need to migrate these rules.
See the use case [I'm using custom rules]({{ baseurl }}pmd_userdocs_migrating_to_pmd7.html#im-using-custom-rules)
in the Migration Guide.
#### Rule Changes