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

MDEP-938] Correct invalid property name and add deprecated old one #404

Merged
merged 1 commit into from
Jun 6, 2024

Conversation

hazendaz
Copy link
Contributor

@hazendaz hazendaz commented Jun 3, 2024

property = "mdep.overIfNewer" is incorrect as a mismatch on the naming and should have been "mdep.overWriteIfNewer" to respect naming convention as all others do. All examples show using the more general property as 'overWriteIfNewer' so its odd to pass -Dmdep.overIfNewer instead of expected correct value. I suspect this is a rare situation and was not an issue that I had but something I noticed when reviewing the code. The original PR I opened #285 went unmerged and was requested to add a deprecated property for the original along with jira. Due to how its used, I didn't see a very good way to make the invalid usage populate the correct one. Maybe there is a better way here. So for now, the misnamed original 'mdep.overIfNewer' is over a property that is unused simply noting its deprecation. I added since 3.7.0 which is also odd considering this is simply a fix and the original is entirely still used throughout as it was entirely correct. Just the property name attribute was incorrect.

I otherwise didn't add any new tests or anything to this situation but could if needed. Might be better if some error is thrown if the original is even populated as I suspect this along is not enough to indicate it got deprecated since that won't show up in the use case.

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 [MDEP-XXX] - Fixes bug in ApproximateQuantiles,
    where you replace MDEP-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.

Sorry, something went wrong.

should be 'overWriteIfNewer' instead of 'overIfNewer' for clarity.
@slawekjaranowski slawekjaranowski self-assigned this Jun 3, 2024
@slawekjaranowski slawekjaranowski merged commit ad5fdc5 into apache:master Jun 6, 2024
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants