Skip to content

[apex][plsql][java] Deprecate base rule classes#2608

Merged
adangel merged 5 commits into
pmd:masterfrom
adangel:deprecate-base-rule-classes
Jun 26, 2020
Merged

[apex][plsql][java] Deprecate base rule classes#2608
adangel merged 5 commits into
pmd:masterfrom
adangel:deprecate-base-rule-classes

Conversation

@adangel

@adangel adangel commented Jun 20, 2020

Copy link
Copy Markdown
Member

Describe the PR

Ready?

  • Added unit tests for fixed bug/feature
  • Passing all unit tests
  • Complete build ./mvnw clean verify passes (checked automatically by travis)
  • Added (in-code) documentation (if needed)

@adangel adangel added this to the 6.25.0 milestone Jun 20, 2020
@adangel adangel added the is:deprecation The main focus is deprecating public APIs or rules, eg to make them internal, or removing them label Jun 20, 2020
@ghost

ghost commented Jun 20, 2020

Copy link
Copy Markdown
1 Message
📖 This changeset introduces 0 new violations, 0 new errors and 0 new configuration errors,
removes 0 violations, 0 errors and 0 configuration errors.
Full report

Generated by 🚫 Danger

@oowekyala

Copy link
Copy Markdown
Member

Maybe this is a good occasion to take a stance on whether rule implementations are internal or not? We should probably not deprecate them, but possibly just mention this in the release notes

@adangel

adangel commented Jun 22, 2020

Copy link
Copy Markdown
Member Author

Maybe this is a good occasion to take a stance on whether rule implementations are internal or not? We should probably not deprecate them, but possibly just mention this in the release notes

Yes, that's right. I think, we should consider rule implementation as internal, so that we don't need to provide any guarantees and can refactor them as needed. The rule implementation classes should never be used directly, only via the category rulesets.

I'll try to come up with a sentence here for the release notes, but I think, it needs to be additionally documented (similar to https://pmd.github.io/latest/pmd_devdocs_rule_deprecation_policy.html) as part of the documentation tasks (see #1139 , I would add it to the "Developer Documentation").

@adangel adangel self-assigned this Jun 26, 2020
@adangel adangel merged commit acbbbee into pmd:master Jun 26, 2020
@adangel adangel deleted the deprecate-base-rule-classes branch June 26, 2020 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

is:deprecation The main focus is deprecating public APIs or rules, eg to make them internal, or removing them

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[apex][plsql][java] Deprecate overly specific base rule classes

2 participants