-
Notifications
You must be signed in to change notification settings - Fork 74
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
Deprecate detect.project.codelocation.unmap property #1295
base: master
Are you sure you want to change the base?
Conversation
.setCategory(DetectCategory.Advanced) | ||
.setDeprecated( | ||
"This property has been deprecated.", | ||
DetectMajorVersion.ELEVEN |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Assuming this is the pattern we follow for other deprecations (haven't personally done or reviewed an MR for a previous deprecation), but should this version be the version we deprecate or the version at which we will officially remove?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you know if .setDeprecated() is used to populate https://documentation.blackduck.com/bundle/detect/page/properties/deprecated-properties.html?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Assuming this is the pattern we follow for other deprecations (haven't personally done or reviewed an MR for a previous deprecation), but should this version be the version we deprecate or the version at which we will officially remove?
This refers to the version in which we will remove the property.
With this change, the following is part of Detect log output when a user attempts to use this property: This property has been deprecated. This property will be removed in 11.0.0.
.
Do you know if .setDeprecated() is used to populate https://documentation.blackduck.com/bundle/detect/page/properties/deprecated-properties.html?
I am pretty sure that the answer is "yes". I was trying to confirm by running release-qa but didn't have much luck.
I looked at GenerateDocsTask.java
and it appears to grab values from a *-help.json
file which is generated based on this list of properties.
@sig-cpotts mentioned that he might be able to confirm this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sig-cpotts confirmed this by generating the page on his end:
Description
Deprecate detect.project.codelocation.unmap property.
With this change, when the property is used, the following is displayed in the log: