Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MENFORCER-454] Deprecate 'rules' property and introduce 'enforcer.rules' as a replacement #211

Merged
merged 1 commit into from
Dec 29, 2022

Conversation

psiroky
Copy link
Contributor

@psiroky psiroky commented Dec 29, 2022

This aligns the property names to us the enforcer. prefix.

Also updated the ITs to verify the rules are indeed getting fully replaced with the list from the property

Following this checklist to help us incorporate your
contribution quickly and easily:

  • Make sure there is a JIRA issue filed
    for the change (usually before you start working on it). Trivial changes like typos do not
    require a JIRA issue. Your pull request should address just this issue, without
    pulling in other changes.
  • Each commit in the pull request should have a meaningful subject line and body.
  • Format the pull request title like [MENFORCER-XXX] - Fixes bug in ApproximateQuantiles,
    where you replace MENFORCER-XXX with the appropriate JIRA issue. Best practice
    is to use the JIRA issue title in the pull request title and in the first line of the
    commit message.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Run mvn clean verify to make sure basic checks pass. A more thorough check will
    be performed on your pull request automatically.
  • You have run the integration tests successfully (mvn -Prun-its clean verify).

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

…les' as a replacement

 * updated the ITs to verify the rules are indeed getting fully replaced
   with the list from the property
@psiroky
Copy link
Contributor Author

psiroky commented Dec 29, 2022

@slawekjaranowski I applied your suggestions (hopefully correctly). I also added a warn log when using the old property. Please take another look when you get a chance.

@Parameter(required = false, property = "rules")
@Deprecated
public void setCommandLineRules(List<String> rulesToExecute) throws MojoExecutionException {
getLog().warn("Detected the usage of property '-Drules' which is deprecated. Use '-Denforcer.rules' instead.");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maven 3.9 will take care about it and warn about deprecated items ... but can be now

@slawekjaranowski slawekjaranowski merged commit 495818f into apache:master Dec 29, 2022
@psiroky psiroky deleted the MENFORCER-454 branch December 29, 2022 20:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants