PMD CI (pmd-bot)
2023-04-19 03:49:24 +00:00
parent 48352c7041
commit 720e24cb9a
9 changed files with 576 additions and 179 deletions

View File

@ -3,10 +3,10 @@
<channel>
<title></title>
<description>Intended as a documentation theme based on Jekyll for technical writers documenting software and other technical products, this theme has all the elements you would need to handle multiple products with both multi-level sidebar navigation, tags, and other documentation features.</description>
<link>https://pmd.github.io/pmd/</link>
<atom:link href="https://pmd.github.io/pmd/feed.xml" rel="self" type="application/rss+xml"/>
<pubDate>Wed, 19 Apr 2023 03:45:27 +0000</pubDate>
<lastBuildDate>Wed, 19 Apr 2023 03:45:27 +0000</lastBuildDate>
<link>https://docs.pmd-code.org/latest/</link>
<atom:link href="https://docs.pmd-code.org/latest/feed.xml" rel="self" type="application/rss+xml"/>
<pubDate>Wed, 19 Apr 2023 03:45:41 +0000</pubDate>
<lastBuildDate>Wed, 19 Apr 2023 03:45:41 +0000</lastBuildDate>
<generator>Jekyll v3.9.3</generator>
</channel>

View File

@ -1615,14 +1615,6 @@ e.g. in <a href="https://github.com/pmd/pmd.github.io/blob/master/_includes/home
</li>
</ul>
</li>
<li>Documentation for the latest release: <a href="https://pmd.github.io/latest/">https://pmd.github.io/latest/</a>
<ul>
<li>The PMD documentation of the latest release is simply copied as static html into the folder <a href="https://github.com/pmd/pmd.github.io/tree/master/latest">latest/</a>.
This makes the latest release documentation available under the stable URL
<a href="https://pmd.github.io/latest/">https://pmd.github.io/latest/</a>. This URL is also used for the <a href="https://github.com/pmd/pmd.github.io/blob/master/sitemap.xml">sitemap.xml</a>.</li>
</ul>
</li>
<li>Documentation for previous releases are still being kept under the folders <code class="language-plaintext highlighter-rouge">pmd-&lt;version&gt;/</code>.</li>
</ul>
<h2 id="building-the-page-locally">Building the page locally</h2>

View File

@ -1629,7 +1629,7 @@ e.g. it requires that the repo <code class="language-plaintext highlighter-rouge
<p>The script <code class="language-plaintext highlighter-rouge">do-release.sh</code> is called in the directory <code class="language-plaintext highlighter-rouge">/home/joe/source/pmd</code> and searches for <code class="language-plaintext highlighter-rouge">../pmd.github.io</code>.</p>
<p>Also make sure, that the repo “pmd.github.io” is locally up to date and has no local changes.</p>
<p>Also make sure, that the repo “pmd.github.io” is locally up-to-date and has no local changes.</p>
<h3 id="the-release-notes-and-docs">The Release Notes and docs</h3>
@ -1766,11 +1766,8 @@ Also create a symlink from pmd-doc-6.34.0-SNAPSHOT to pmd-doc-6.34.0, so that ol
<li>Remove old javadoc for the SNAPSHOT version, e.g. delete <a href="https://docs.pmd-code.org/apidocs/pmd-core/6.34.0-SNAPSHOT/">https://docs.pmd-code.org/apidocs/pmd-core/6.34.0-SNAPSHOT/</a>.</li>
<li>Create a draft news post on <a href="https://sourceforge.net/p/pmd/news/">https://sourceforge.net/p/pmd/news/</a> for the new release. This contains the
rendered release notes.</li>
<li>Add the documentation of the new release to a subfolder on <a href="https://pmd.github.io">https://pmd.github.io</a>, also make
this folder available as <code class="language-plaintext highlighter-rouge">latest</code>, so that <a href="https://pmd.github.io/latest/">https://pmd.github.io/latest/</a> shows the new
version and <a href="https://pmd.github.io/pmd-6.34.0/">https://pmd.github.io/pmd-6.34.0/</a> is the URL for the specific release.</li>
<li>Also copy the documentation to sourceforges web space, so that it is available as
<a href="https://pmd.sourceforge.io/pmd-6.34.0/">https://pmd.sourceforge.io/pmd-6.34.0/</a>. All previously copied version are listed
<li>Copy the documentation to sourceforges web space, so that it is available as
<a href="https://pmd.sourceforge.io/pmd-6.34.0/">https://pmd.sourceforge.io/pmd-6.34.0/</a>. All previously copied versions are listed
under <a href="https://pmd.sourceforge.io/archive.phtml">https://pmd.sourceforge.io/archive.phtml</a>.</li>
<li>After all this is done, the release on github (<a href="https://github.com/pmd/pmd/releases">https://github.com/pmd/pmd/releases</a>) is published
and the news post on sourceforge (https://sourceforge.net/p/pmd/news/&gt; is publishes as well.</li>
@ -1792,7 +1789,7 @@ news:</p>
<ul>
<li>Downloads: https://github.com/pmd/pmd/releases/tag/pmd_releases%2F<version></version></li>
<li>Documentation: https://pmd.github.io/pmd-<version>/</version></li>
<li>Documentation: https://docs.pmd-code.org/pmd-doc-<version>/</version></li>
</ul>
<p>And Copy-Paste the release notes</p>
@ -1855,6 +1852,12 @@ news:</p>
<td><a href="https://docs.pmd-code.org/latest/">https://docs.pmd-code.org/latest/</a></td>
<td><input type="checkbox" /></td>
</tr>
<tr>
<td>docs2</td>
<td>New version in the docs is listed under “Version specific documentation”</td>
<td><a href="https://docs.pmd-code.org/">https://docs.pmd-code.org/</a></td>
<td><input type="checkbox" /></td>
</tr>
<tr>
<td>docs-archive</td>
<td>New docs are also on archive site</td>
@ -1968,7 +1971,7 @@ In theory, the fixes should already be there, but you never now.</p>
<p>If releases from multiple branches are being done, the order matters. You should start from the “oldest” branch,
e.g. <code class="language-plaintext highlighter-rouge">pmd/5.4.x</code>, release from there. Then merge (see above) into the next branch, e.g. <code class="language-plaintext highlighter-rouge">pmd/5.5.x</code> and release
from there. Then merge into the <code class="language-plaintext highlighter-rouge">master</code> branch and release from there. This way, the last release done, becomes
automatically the latest release on <a href="https://pmd.github.io/latest/">https://pmd.github.io/latest/</a> and on sourceforge.</p>
automatically the latest release on <a href="https://docs.pmd-code.org/latest/">https://docs.pmd-code.org/latest/</a> and on sourceforge.</p>
<h3 id="optional-create-a-new-release-branch">(Optional) Create a new release branch</h3>

View File

@ -1612,8 +1612,13 @@ for all.</p>
<p>This section lists the most important changes from the last release candidate.
The remaining section describe the complete release notes for 7.0.0.</p>
<p>Fixed Issues:</p>
<h4 id="fixed-issues">Fixed issues</h4>
<ul>
<li>documentation
<ul>
<li><a href="https://github.com/pmd/pmd/issues/4438">#4438</a>: [doc] Documentation links in VS Code are outdated</li>
</ul>
</li>
<li>miscellaneous
<ul>
<li><a href="https://github.com/pmd/pmd/issues/4462">#4462</a>: Provide Software Bill of Materials (SBOM)</li>
@ -1873,6 +1878,11 @@ of the changes listed here, see <a href="pmd_release_notes_pmd7.html">Detailed R
<li><a href="https://github.com/pmd/pmd/issues/4079">#4079</a>: [cli] Split off CLI implementation into a pmd-cli submodule</li>
</ul>
</li>
<li>doc
<ul>
<li><a href="https://github.com/pmd/pmd/issues/4438">#4438</a>: [doc] Documentation links in VS Code are outdated</li>
</ul>
</li>
<li>testing
<ul>
<li><a href="https://github.com/pmd/pmd/issues/2435">#2435</a>: [test] Remove duplicated Dummy language module</li>

View File

@ -1591,7 +1591,7 @@
<p>Were excited to bring you the next major version of PMD!</p>
<p>Since this is a big release, we provide here only a concise version of the release notes. We prepared a separate
page with the full <a href="https://pmd.github.io/pmd-7.0.0-rc1/pmd_release_notes_pmd7.html">Detailed Release Notes for PMD 7.0.0</a>.</p>
page with the full <a href="https://docs.pmd-code.org/pmd-doc-7.0.0-rc1/pmd_release_notes_pmd7.html">Detailed Release Notes for PMD 7.0.0</a>.</p>
<div style="border: 1px solid; border-radius: .25rem; padding: .75rem 1.25rem;" role="alert">
<strong> Release Candidates</strong>
@ -1647,7 +1647,7 @@ for all.</p>
<p>The new official logo of PMD:</p>
<p><img src="https://pmd.github.io/pmd-7.0.0-rc1/images/logo/pmd-logo-300px.png" alt="New PMD Logo" /></p>
<p><img src="https://docs.pmd-code.org/pmd-doc-7.0.0-rc1/images/logo/pmd-logo-300px.png" alt="New PMD Logo" /></p>
<h4 id="revamped-java-module">Revamped Java module</h4>
@ -1679,7 +1679,7 @@ for all.</p>
<li>shell completion</li>
</ul>
<p><img src="https://pmd.github.io/pmd-7.0.0-rc1/images/userdocs/pmd-demo.gif" alt="Demo" /></p>
<p><img src="https://docs.pmd-code.org/pmd-doc-7.0.0-rc1/images/userdocs/pmd-demo.gif" alt="Demo" /></p>
<p>For more information, see the <a href="pmd_release_notes_pmd7.html">Detailed Release Notes for PMD 7</a>.</p>
@ -1744,26 +1744,26 @@ For more information on the languages, see the <a href="pmd_release_notes_pmd7.h
<p><strong>Apex</strong></p>
<ul>
<li><a href="https://pmd.github.io/pmd-7.0.0-rc1/pmd_rules_apex_design.html#unusedmethod"><code class="language-plaintext highlighter-rouge">UnusedMethod</code></a> finds unused methods in your code.</li>
<li><a href="https://docs.pmd-code.org/pmd-doc-7.0.0-rc1/pmd_rules_apex_design.html#unusedmethod"><code class="language-plaintext highlighter-rouge">UnusedMethod</code></a> finds unused methods in your code.</li>
</ul>
<p><strong>Java</strong></p>
<ul>
<li><a href="https://pmd.github.io/pmd-7.0.0-rc1/pmd_rules_java_codestyle.html#unnecessaryboxing"><code class="language-plaintext highlighter-rouge">UnnecessaryBoxing</code></a> reports boxing and unboxing conversions that may be made implicit.</li>
<li><a href="https://docs.pmd-code.org/pmd-doc-7.0.0-rc1/pmd_rules_java_codestyle.html#unnecessaryboxing"><code class="language-plaintext highlighter-rouge">UnnecessaryBoxing</code></a> reports boxing and unboxing conversions that may be made implicit.</li>
</ul>
<p><strong>Kotlin</strong></p>
<ul>
<li><a href="https://pmd.github.io/pmd-7.0.0-rc1/pmd_rules_kotlin_bestpractices.html#functionnametooshort"><code class="language-plaintext highlighter-rouge">FunctionNameTooShort</code></a></li>
<li><a href="https://pmd.github.io/pmd-7.0.0-rc1/pmd_rules_kotlin_errorprone.html#overridebothequalsandhashcode"><code class="language-plaintext highlighter-rouge">OverrideBothEqualsAndHashcode</code></a></li>
<li><a href="https://docs.pmd-code.org/pmd-doc-7.0.0-rc1/pmd_rules_kotlin_bestpractices.html#functionnametooshort"><code class="language-plaintext highlighter-rouge">FunctionNameTooShort</code></a></li>
<li><a href="https://docs.pmd-code.org/pmd-doc-7.0.0-rc1/pmd_rules_kotlin_errorprone.html#overridebothequalsandhashcode"><code class="language-plaintext highlighter-rouge">OverrideBothEqualsAndHashcode</code></a></li>
</ul>
<p><strong>Swift</strong></p>
<ul>
<li><a href="https://pmd.github.io/pmd-7.0.0-rc1/pmd_rules_swift_bestpractices.html#prohibitedinterfacebuilder"><code class="language-plaintext highlighter-rouge">ProhibitedInterfaceBuilder</code></a></li>
<li><a href="https://pmd.github.io/pmd-7.0.0-rc1/pmd_rules_swift_bestpractices.html#unavailablefunction"><code class="language-plaintext highlighter-rouge">UnavailableFunction</code></a></li>
<li><a href="https://pmd.github.io/pmd-7.0.0-rc1/pmd_rules_swift_errorprone.html#forcecast"><code class="language-plaintext highlighter-rouge">ForceCast</code></a></li>
<li><a href="https://pmd.github.io/pmd-7.0.0-rc1/pmd_rules_swift_errorprone.html#forcetry"><code class="language-plaintext highlighter-rouge">ForceTry</code></a></li>
<li><a href="https://docs.pmd-code.org/pmd-doc-7.0.0-rc1/pmd_rules_swift_bestpractices.html#prohibitedinterfacebuilder"><code class="language-plaintext highlighter-rouge">ProhibitedInterfaceBuilder</code></a></li>
<li><a href="https://docs.pmd-code.org/pmd-doc-7.0.0-rc1/pmd_rules_swift_bestpractices.html#unavailablefunction"><code class="language-plaintext highlighter-rouge">UnavailableFunction</code></a></li>
<li><a href="https://docs.pmd-code.org/pmd-doc-7.0.0-rc1/pmd_rules_swift_errorprone.html#forcecast"><code class="language-plaintext highlighter-rouge">ForceCast</code></a></li>
<li><a href="https://docs.pmd-code.org/pmd-doc-7.0.0-rc1/pmd_rules_swift_errorprone.html#forcetry"><code class="language-plaintext highlighter-rouge">ForceTry</code></a></li>
</ul>
<h4 id="changed-rules">Changed Rules</h4>
@ -1771,27 +1771,27 @@ For more information on the languages, see the <a href="pmd_release_notes_pmd7.h
<p><strong>Java</strong></p>
<ul>
<li><a href="https://pmd.github.io/pmd-7.0.0-rc1/pmd_rules_java_codestyle.html#unnecessaryfullyqualifiedname"><code class="language-plaintext highlighter-rouge">UnnecessaryFullyQualifiedName</code></a>: the rule has two new properties,
<li><a href="https://docs.pmd-code.org/pmd-doc-7.0.0-rc1/pmd_rules_java_codestyle.html#unnecessaryfullyqualifiedname"><code class="language-plaintext highlighter-rouge">UnnecessaryFullyQualifiedName</code></a>: the rule has two new properties,
to selectively disable reporting on static field and method qualifiers. The rule also has been improved
to be more precise.</li>
<li><a href="https://pmd.github.io/pmd-7.0.0-rc1/pmd_rules_java_codestyle.html#uselessparentheses"><code class="language-plaintext highlighter-rouge">UselessParentheses</code></a>: the rule has two new properties which control how strict
<li><a href="https://docs.pmd-code.org/pmd-doc-7.0.0-rc1/pmd_rules_java_codestyle.html#uselessparentheses"><code class="language-plaintext highlighter-rouge">UselessParentheses</code></a>: the rule has two new properties which control how strict
the rule should be applied. With <code class="language-plaintext highlighter-rouge">ignoreClarifying</code> (default: true) parentheses that are strictly speaking
not necessary are allowed, if they separate expressions of different precedence.
The other property <code class="language-plaintext highlighter-rouge">ignoreBalancing</code> (default: true) is similar, in that it allows parentheses that help
reading and understanding the expressions.</li>
<li><a href="https://pmd.github.io/pmd-7.0.0-rc1/pmd_rules_java_bestpractices.html#loosecoupling"><code class="language-plaintext highlighter-rouge">LooseCoupling</code></a>: the rule has a new property to allow some types to be coupled
<li><a href="https://docs.pmd-code.org/pmd-doc-7.0.0-rc1/pmd_rules_java_bestpractices.html#loosecoupling"><code class="language-plaintext highlighter-rouge">LooseCoupling</code></a>: the rule has a new property to allow some types to be coupled
to (<code class="language-plaintext highlighter-rouge">allowedTypes</code>).</li>
<li><a href="https://pmd.github.io/pmd-7.0.0-rc1/pmd_rules_java_errorprone.html#emptycatchblock"><code class="language-plaintext highlighter-rouge">EmptyCatchBlock</code></a>: <code class="language-plaintext highlighter-rouge">CloneNotSupportedException</code> and <code class="language-plaintext highlighter-rouge">InterruptedException</code> are not
<li><a href="https://docs.pmd-code.org/pmd-doc-7.0.0-rc1/pmd_rules_java_errorprone.html#emptycatchblock"><code class="language-plaintext highlighter-rouge">EmptyCatchBlock</code></a>: <code class="language-plaintext highlighter-rouge">CloneNotSupportedException</code> and <code class="language-plaintext highlighter-rouge">InterruptedException</code> are not
special-cased anymore. Rename the exception parameter to <code class="language-plaintext highlighter-rouge">ignored</code> to ignore them.</li>
<li><a href="https://pmd.github.io/pmd-7.0.0-rc1/pmd_rules_java_errorprone.html#dontimportsun"><code class="language-plaintext highlighter-rouge">DontImportSun</code></a>: <code class="language-plaintext highlighter-rouge">sun.misc.Signal</code> is not special-cased anymore.</li>
<li><a href="https://pmd.github.io/pmd-7.0.0-rc1/pmd_rules_java_codestyle.html#usediamondoperator"><code class="language-plaintext highlighter-rouge">UseDiamondOperator</code></a>: the property <code class="language-plaintext highlighter-rouge">java7Compatibility</code> is removed. The rule now
<li><a href="https://docs.pmd-code.org/pmd-doc-7.0.0-rc1/pmd_rules_java_errorprone.html#dontimportsun"><code class="language-plaintext highlighter-rouge">DontImportSun</code></a>: <code class="language-plaintext highlighter-rouge">sun.misc.Signal</code> is not special-cased anymore.</li>
<li><a href="https://docs.pmd-code.org/pmd-doc-7.0.0-rc1/pmd_rules_java_codestyle.html#usediamondoperator"><code class="language-plaintext highlighter-rouge">UseDiamondOperator</code></a>: the property <code class="language-plaintext highlighter-rouge">java7Compatibility</code> is removed. The rule now
handles Java 7 properly without a property.</li>
<li><a href="https://pmd.github.io/pmd-7.0.0-rc1/pmd_rules_java_design.html#singularfield"><code class="language-plaintext highlighter-rouge">SingularField</code></a>: Properties <code class="language-plaintext highlighter-rouge">checkInnerClasses</code> and <code class="language-plaintext highlighter-rouge">disallowNotAssignment</code> are removed.
<li><a href="https://docs.pmd-code.org/pmd-doc-7.0.0-rc1/pmd_rules_java_design.html#singularfield"><code class="language-plaintext highlighter-rouge">SingularField</code></a>: Properties <code class="language-plaintext highlighter-rouge">checkInnerClasses</code> and <code class="language-plaintext highlighter-rouge">disallowNotAssignment</code> are removed.
The rule is now more precise and will check these cases properly.</li>
<li><a href="https://pmd.github.io/pmd-7.0.0-rc1/pmd_rules_java_design.html#useutilityclass"><code class="language-plaintext highlighter-rouge">UseUtilityClass</code></a>: The property <code class="language-plaintext highlighter-rouge">ignoredAnnotations</code> has been removed.</li>
<li><a href="https://pmd.github.io/pmd-7.0.0-rc1/pmd_rules_java_design.html#lawofdemeter"><code class="language-plaintext highlighter-rouge">LawOfDemeter</code></a>: the rule has a new property <code class="language-plaintext highlighter-rouge">trustRadius</code>. This defines the maximum degree
<li><a href="https://docs.pmd-code.org/pmd-doc-7.0.0-rc1/pmd_rules_java_design.html#useutilityclass"><code class="language-plaintext highlighter-rouge">UseUtilityClass</code></a>: The property <code class="language-plaintext highlighter-rouge">ignoredAnnotations</code> has been removed.</li>
<li><a href="https://docs.pmd-code.org/pmd-doc-7.0.0-rc1/pmd_rules_java_design.html#lawofdemeter"><code class="language-plaintext highlighter-rouge">LawOfDemeter</code></a>: the rule has a new property <code class="language-plaintext highlighter-rouge">trustRadius</code>. This defines the maximum degree
of trusted data. The default of 1 is the most restrictive.</li>
<li><a href="https://pmd.github.io/pmd-7.0.0-rc1/pmd_rules_java_documentation.html#commentcontent"><code class="language-plaintext highlighter-rouge">CommentContent</code></a>: The properties <code class="language-plaintext highlighter-rouge">caseSensitive</code> and <code class="language-plaintext highlighter-rouge">disallowedTerms</code> are removed. The
<li><a href="https://docs.pmd-code.org/pmd-doc-7.0.0-rc1/pmd_rules_java_documentation.html#commentcontent"><code class="language-plaintext highlighter-rouge">CommentContent</code></a>: The properties <code class="language-plaintext highlighter-rouge">caseSensitive</code> and <code class="language-plaintext highlighter-rouge">disallowedTerms</code> are removed. The
new property <code class="language-plaintext highlighter-rouge">fobiddenRegex</code> can be used now to define the disallowed terms with a single regular
expression.</li>
</ul>

View File

@ -1589,7 +1589,7 @@
<!-- DO NOT EDIT THIS FILE. This file is generated from file ../pmd-swift/src/main/resources/category/swift/bestpractices.xml. -->
<h2 id="prohibitedinterfacebuilder">ProhibitedInterfaceBuilder</h2>
<p><strong>Since:</strong> PMD 7.0</p>
<p><strong>Since:</strong> PMD 7.0.0</p>
<p><strong>Priority:</strong> Medium High (2)</p>
@ -1621,7 +1621,7 @@ Consider building views programmatically.</p>
<h2 id="unavailablefunction">UnavailableFunction</h2>
<p><strong>Since:</strong> PMD 7.0</p>
<p><strong>Since:</strong> PMD 7.0.0</p>
<p><strong>Priority:</strong> Medium (3)</p>

View File

@ -1589,7 +1589,7 @@
<!-- DO NOT EDIT THIS FILE. This file is generated from file ../pmd-swift/src/main/resources/category/swift/errorprone.xml. -->
<h2 id="forcecast">ForceCast</h2>
<p><strong>Since:</strong> PMD 7.0</p>
<p><strong>Since:</strong> PMD 7.0.0</p>
<p><strong>Priority:</strong> Medium (3)</p>
@ -1614,7 +1614,7 @@ Consider using conditional casting and handling the resulting optional.</p>
<h2 id="forcetry">ForceTry</h2>
<p><strong>Since:</strong> PMD 7.0</p>
<p><strong>Since:</strong> PMD 7.0.0</p>
<p><strong>Priority:</strong> Medium (3)</p>

View File

@ -7,7 +7,7 @@
"driver": {
"name": "PMD",
"version": "<pmd-version>",
"informationUri": "https://pmd.github.io/pmd/",
"informationUri": "https://docs.pmd-code.org/latest/",
"rules": [
{
"id": "ApexSharingViolations",
@ -17,7 +17,7 @@
"fullDescription": {
"text": "Detect classes declared without explicit sharing mode if DML methods are used. This forces the developer to take access restrictions into account before modifying objects."
},
"helpUri": "https://pmd.github.io/pmd/pmd_rules_apex_security.html#apexsharingviolations",
"helpUri": "https://docs.pmd-code.org/latest/pmd_rules_apex_security.html#apexsharingviolations",
"help": {
"text": "Detect classes declared without explicit sharing mode if DML methods are used. This forces the developer to take access restrictions into account before modifying objects."
},
@ -37,7 +37,7 @@
"fullDescription": {
"text": "This rule validates that: ApexDoc comments are present for classes, methods, and properties that are public or global, excluding overrides and test classes (as well as the contents of test classes)."
},
"helpUri": "https://pmd.github.io/pmd/pmd_rules_apex_documentation.html#apexdoc",
"helpUri": "https://docs.pmd-code.org/latest/pmd_rules_apex_documentation.html#apexdoc",
"help": {
"text": "This rule validates that: ApexDoc comments are present for classes, methods, and properties that are public or global, excluding overrides and test classes (as well as the contents of test classes)."
},

File diff suppressed because it is too large Load Diff