PMD 7 Tracking Issue

[oowekyala]

✔️ Release Candidate 1

Topic: Finish open PRs and finish Java module
Version: 7.0.0-rc1

Task list for 7.0.0-rc1

Open PRs

• in:cli
  • [core,cli] Move some tests into pmd-cli #4235
• in:testing
  • Migrate to JUnit5 - Part 3 #4155
• in:pmd-internals
  • [core] Remove deprecated classes/methods (finish #881) #4342
• unlabelled
  • [core] Language lifecycle #4060

Tasks, that are almost done

(because we have an open PR for it)

• in:pmd-internals
  • [all] Breaking API changes for 7.0.0 #881
    • PR: [core] Remove deprecated classes/methods (finish #881) #4342
• in:testing
  • [all] Use JUnit5 #3797
    • PR: Migrate to JUnit5 - Part 3 #4155
• General Language Plugin Support
  • [core] Language properties #2518
    • PR: [core] Language lifecycle #4060
  • [core] Language lifecycle #3782
    • PR: [core] Language lifecycle #4060

Java

• in:ast
  • [java] Some AST nodes should not be TypeNodes #4317
• [java] Move testrule TypeResTest into internal #4367

Other

• General Language Plugin Support
  • [core] Explicitly name all language versions #4120
    • [core] Explicitly name all language versions #4387
• in:pmd-internals
  • [core] Utility classes in pmd 7 #2873
• in:testing
  • [test] Remove duplicated Dummy language module #2435
• [doc] Update release notes for PMD 7.0.0-rc1 #4373
• ❗ Check release scripts
  • Do the release scripts for pmd7 work on master? Doc deployment, etc.

✔️ Release Candidate 2

Topic: Finish Documentation
Version: 7.0.0-rc2

Task list for 7.0.0-rc2

ANTLR Support

• [core] Clarify API for ANTLR based languages #2500
  • [core] Antlr API changes #4471
• [doc] Verify ANTLR Documentation #2501
  • [doc] Update ANTLR documentation #4473

Documentation

• User Documentation
  • [doc] Differences in rules in pmd 7 vs pmd 6 #3123
    • [doc] Document rule changes for PMD 7 #4501
  • Update PMD 7 Logo on various places #4307
    • [doc] Add additional logos with a square shape #4447

✔️ Release Candidate 3

Task list for 7.0.0-rc3

Miscellaneous bug fixes - see release notes

✔️ Release Candidate 4

Topic: Cleanup, Release Notes, Prepare dependent projects
Version: 7.0.0-rc4

Task list for 7.0.0-rc4

Spill over from rc2

• User Documentation
  • [doc] Migration Guide for upgrading PMD 6 ➡️ 7 #4294
    • [doc] Add migration guide for PMD 7 #4590
• Developer Documentation
  • [doc] Document new property framework #4303
    • Part of [core] Update properties framework #4380

Spill over from rc3

• Cleanup Tasks (remove deprecated API, promote experimental api, DeprecatedUntil700)
  • Property API
    • [core] Remove deprecated property concrete classes #4301
      • Part of [core] Update properties framework #4380
    • [core] Migrate Property Framework API to Java 8 #4302
      • Part of [core] Update properties framework #4380
• Apex
  • in:grammar
    • [apex] Merge main (7.x) branch into experimental-apex-parser and fix tests #4479

Dependents update

Some dependent projects need to be updated when we release PMD 7

• pmd/pmd.github.io
  • Branch: pmd7
• pmd/pmd-designer
  • Branch: compat-7.0
  • Update PMD 7 Logo in the Designer pmd-designer#43
• pmd/pmd-eclipse-plugin
  • Update PMD 7 Logo in eclipse pmd plugin pmd-eclipse-plugin#122
• pmd/pmd-examples
  • Update to PMD 7.0.0-rc3 pmd-examples#3
• Support for upcoming 7.0.0 ChuckJonas/vscode-apex-pmd#124
  • Add support for PMD 7 ChuckJonas/vscode-apex-pmd#130

✔️ Final 7.0.0

Topic: Cleanup, Release Notes, Prepare dependent projects
Version: 7.0.0

Task list for Final 7.0.0

Spill over from rc2

• Developer Documentation
  • [doc] Document API evolution principles as ADR #995
    • [doc] ADR 3 - API evolution principles #4756
  • [doc] Review guides for writing java/xpath rules for correctness with PMD 7 #2511
    • [doc] Review rule writing documentation for PMD 7 #4762
  • [doc] Document language module features #3175
    • [doc] Update language modules #4661
  • [doc] Document XPath API @NoAttribute and @DeprecatedAttribute #4308
    • [doc] Document XPath integration (#4308) #4764
  • [doc] Document TypeRes API and Symbols API #4319
    • [doc] Document TypeRes API and Symbols API (#4319) #4766

Spill over from rc3

• Cleanup Tasks (remove deprecated API, promote experimental api, DeprecatedUntil700)
  • Java
    • [java] AccessNode API changes #1307
      • fixed by [java] Updates to AST nodes #4768
    • [java] Rename some node types #3751
      • fixed by [java] Updates to AST nodes #4768
  • in:pmd-internals
    • [core] Apply the new PropertyDescriptor<Pattern> type where applicable #1027
      • Partially covered in [core] Update properties framework #4380 but XPath properties are still pending
      • [java] Make allowExceptionNameRegex a Regex #4724
  • in:ruleset-xml
    • [core] Remove support for <lang>-<ruleset> hyphen notation for ruleset references #4313
      • fixed by [core] Remove support for deprecated rule set references notation #4786
    • [core] Remove ruleset compatibility filter (RuleSetFactoryCompatibility) and CLI option --no-ruleset-compatibility #4314
      • fixed by [core] Remove ruleset compatibility filter (RuleSetFactoryCompatibili… #4795
  • in:grammar
    • [core] Rename TokenMgrError to LexException, Tokenizer to CpdLexer #4065
      • it's small
      • it can be considered as cleanup
      • fixed by [core] Rename TokenMgrError to LexException, Tokenizer to CpdLexer #4797
  • Property API
    • [core] Remove unnecessary property color and system property pmd.color in TextColorRenderer #4312
      • fixed by [core] TextColorRenderer: Remove property color #4798
  • Rule API
    • [core] Consolidate n.s.pmd.lang.rule package #3917
      • fixed by [core] Consolidate n.s.pmd.lang.rule package #4799
  • Renderer and Reporting and Violation API
    • [core] Consolidate n.s.pmd.reporting package #3903
      • fixed by [core] Consolidate n.s.pmd.reporting package #4803
  • in:xpath
    • [core] Cleanups in XPath area #4309
      • fixed by [core] XPath cleanups #4804
  • unlabelled
    • [core] Stabilize tree export API #3905
      • fixed by [core] Promote Tree Export API as stable #4808
    • [core] Consolidate @InternalApi classes #4348
      • fixed by [core] Consolidate @InternalApi classes #4809
    • [core] Cleanup remaining experimental and deprecated API #4349
      • fixed by Cleanup remaining experimental and deprecated API #4811
• Apex
  • in:grammar
    • [apex] Replace Jorje with fully open source front-end #3766
      • almost done
      • PMD7 wouldn't depend anymore on jorje (smaller footprint, etc.)
      • fixed by [apex] Use apex-parser and Summit AST #4806

Dependents update

Some dependent projects need to be updated when we release PMD 7

• ❌ apache/maven-pmd-plugin
  • Branch: pmd7
  • Does maven support PMD 7 (release candidates)? #4478
  • https://issues.apache.org/jira/browse/MPMD-379
  • Post-poned, since there is a solution now: https://docs.pmd-code.org/snapshot/pmd_userdocs_tools_maven.html#using-pmd-7-with-maven-pmd-plugin
• Support for PMD 7.0 gradle/gradle#24502
  • Tested it with gradle 8.6 - it works with PMD 7
  • The referenced issue is about updating the default version to PMD 7 ❓
• Incompatible with latest PMD plugin m2e-code-quality/m2e-code-quality#327

Tasks, that are postponed

See Milestone 7.x

Finished

See Milestone 7.0.0 - closed

[stephen-carter-at-sf]

Hello everyone. On behalf of the Salesforce Code Analyzer team, I am reaching out to ask if there is an estimated date when PMD 7 will be released to be generally available and no longer a release candidate. Is it possible to give us an estimate on this?

[jsotuyod]

@stephen-carter-at-sf we are aiming to cut a release by the end of next week or the weekend at the latest. Only some upkeeping left and merging 2 open PRs with fixes based on RC feedback.

[adangel]

The target release date for PMD 7 will be March, 22nd 2024.

Closing this issue now, since all tasks have been done.