Skip to content

Commit

Permalink
Prepare pmd release 6.54.0
Browse files Browse the repository at this point in the history
  • Loading branch information
adangel committed Jan 28, 2023
1 parent aa64a5e commit cb03162
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/_config.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
repository: pmd/pmd

pmd:
version: 6.54.0-SNAPSHOT
version: 6.54.0
previous_version: 6.53.0
date: 28-January-2023
release_type: minor
Expand Down
47 changes: 47 additions & 0 deletions docs/pages/next_major_development.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,53 @@ the breaking API changes will be performed in 7.0.0.
an API is tagged as `@Deprecated` or not in the latest minor release. During the development of 7.0.0,
we may decide to remove some APIs that were not tagged as deprecated, though we'll try to avoid it." %}

#### 6.54.0

##### PMD CLI

* PMD now supports a new `--relativize-paths-with` flag (or short `-z`), which replaces `--short-names`.
It serves the same purpose: Shortening the pathnames in the reports. However, with the new flag it's possible
to explicitly define one or more pathnames that should be used as the base when creating relative paths.
The old flag `--short-names` is deprecated.

##### Deprecated APIs

###### For removal

* {% jdoc !!apex::lang.apex.ast.ApexRootNode#getApexVersion() %} has been deprecated for removal. The version returned is
always `Version.CURRENT`, as the apex compiler integration doesn't use additional information which Apex version
actually is used. Therefore, this method can't be used to determine the Apex version of the project
that is being analyzed.
* {% jdoc !!core::cpd.CPDConfiguration#setEncoding(java.lang.String) %} and
{% jdoc !!core::cpd.CPDConfiguration#getEncoding() %}. Use the methods
{% jdoc core::AbstractConfiguration#getSourceEncoding() %} and
{% jdoc core::AbstractConfiguration#setSourceEncoding(java.lang.String) %} instead. Both are available
for `CPDConfiguration` which extends `AbstractConfiguration`.
* {% jdoc test::cli.BaseCLITest %} and {% jdoc test::cli.BaseCPDCLITest %} have been deprecated for removal without
replacement. CLI tests should be done in pmd-core only (and in PMD7 in pmd-cli). Individual language modules
shouldn't need to test the CLI integration logic again. Instead, the individual language modules should test their
functionality as unit tests.
* {% jdoc core::cpd.CPDConfiguration.LanguageConverter %}

* {% jdoc !!core::lang.document.FileCollector#addZipFile(java.nio.file.Path) %} has been deprecated. It is replaced
by {% jdoc !!core::lang.document.FileCollector#addZipFileWithContent(java.nio.file.Path) %} which directly adds the
content of the zip file for analysis.

* {% jdoc !!core::PMDConfiguration#setReportShortNames(boolean) %} and
{% jdoc !!core::PMDConfiguration#isReportShortNames() %} have been deprecated for removal.
Use {% jdoc !!core::PMDConfiguration#addRelativizeRoot(java.nio.file.Path) %} instead.

###### Internal APIs

* {% jdoc core::renderers.CSVWriter %}
* Some fields in {% jdoc test::ant.AbstractAntTestHelper %}

###### Experimental APIs

* CPDReport has a new method which limited mutation of a given report:
* {%jdoc core::cpd.CPDReport#filterMatches(net.sourceforge.pmd.util.Predicate) %} creates a new CPD report
with some matches removed with a given predicate based filter.

#### 6.53.0

##### Deprecated APIs
Expand Down
5 changes: 5 additions & 0 deletions docs/pages/release_notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,5 +87,10 @@ See [the example report](report-examples/html-report-v2.html).
* [#4280](https://github.com/pmd/pmd/pull/4280): \[apex] Deprecate ApexRootNode.getApexVersion - [Aaron Hurst](https://github.com/aaronhurst-google) (@aaronhurst-google)
* [#4285](https://github.com/pmd/pmd/pull/4285): \[java] CommentDefaultAccessModifier - add co.elastic.clients.util.VisibleForTesting as default suppressed annotation - [Matthew Luckam](https://github.com/mluckam) (@mluckam)

### Stats
* 107 commits
* 19 closed tickets & PRs
* Days since last release: 27

{% endtocmaker %}

0 comments on commit cb03162

Please sign in to comment.