From 3770a338d21837bdbf7a8bda0b3734a268d8b914 Mon Sep 17 00:00:00 2001 From: "PMD CI (pmd-bot)" Date: Thu, 10 Jun 2021 14:50:11 +0000 Subject: [PATCH] Update documentation https://github.com/pmd/pmd/actions/runs/925481737 https://github.com/pmd/pmd/compare/57bc8f4367ce...d4e57fab4cd5 --- feed.xml | 4 ++-- pmd_release_notes.html | 6 ++++++ report-examples/pmd-report.sarif.json | 22 ++++++++++++++++++++-- 3 files changed, 28 insertions(+), 4 deletions(-) diff --git a/feed.xml b/feed.xml index 235654027b..7945132901 100644 --- a/feed.xml +++ b/feed.xml @@ -5,8 +5,8 @@ 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. https://pmd.github.io/pmd/ - Thu, 10 Jun 2021 14:04:12 +0000 - Thu, 10 Jun 2021 14:04:12 +0000 + Thu, 10 Jun 2021 14:48:18 +0000 + Thu, 10 Jun 2021 14:48:18 +0000 Jekyll v3.9.0 diff --git a/pmd_release_notes.html b/pmd_release_notes.html index 59b58e947c..d5222e10c9 100644 --- a/pmd_release_notes.html +++ b/pmd_release_notes.html @@ -1449,6 +1449,11 @@ You can try out this rule like so:
  • #3321: [apex] New rule to detect inaccessible AuraEnabled getters (summer ‘21 security update)
    • +
  • core +
      +
    • #3323: [core] Adds fullDescription and tags in SARIF report
      • +
    +
  • java-codestyle
    • #3317: [java] Update UnnecessaryImport to recognize usage of imported types in javadoc’s @exception tag
      • @@ -1470,6 +1475,7 @@ You can try out this rule like so:
    • #3317: [java] Update UnnecessaryImport to recognize usage of imported types in javadoc’s @exception tag - Piotrek Żygieło
    • #3320: [java] Fix incorrect increment for “else if” branch in Cognitive Complexity docs - Denis Borovikov
    • #3322: [apex] added rule to detect inaccessible AuraEnabled getters - Philippe Ozil
      • +
    • #3323: [core] Adds fullDescription and tags in SARIF report - Clint Chester
    diff --git a/report-examples/pmd-report.sarif.json b/report-examples/pmd-report.sarif.json index af3c6a7fea..e785af258d 100644 --- a/report-examples/pmd-report.sarif.json +++ b/report-examples/pmd-report.sarif.json @@ -14,10 +14,19 @@ "shortDescription": { "text": "Apex classes should declare a sharing model if DML or SOQL/SOSL is used" }, + "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", + "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." + }, "properties": { "ruleset": "Security", - "priority": 3 + "priority": 3, + "tags":[ + "Security" + ] } }, { @@ -25,10 +34,19 @@ "shortDescription": { "text": "Missing ApexDoc comment" }, + "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", + "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)." + }, "properties": { "ruleset": "Documentation", - "priority": 3 + "priority": 3, + "tags": [ + "Documentation" + ] } } ]