Remove unnecessary exports #2159
Conversation
Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## next #2159 +/- ##
==========================================
- Coverage 91.22% 91.18% -0.05%
==========================================
Files 629 628 -1
Lines 17912 17874 -38
Branches 3795 3692 -103
==========================================
- Hits 16341 16299 -42
- Misses 1570 1574 +4
Partials 1 1 ☔ View full report in Codecov by Sentry. |
| /** | ||
| * @deprecated | ||
| */ | ||
| export abstract class Operation<T> implements ITaskWithStatus { |
There was a problem hiding this comment.
Do we have a planned replacement for the Operation class going forward, or do we plan on removing it entirely? I'm not sure who is all using this as it is an abstract class, but we might want to elaborate on the long-term intentions in the deprecation message.
There was a problem hiding this comment.
From what I saw, nobody ever used this at all.
There was a problem hiding this comment.
That's fair - since its still being exported, do you think we should err on the side of caution and add something short such as "No replacement planned, will be removed in v4"? I don't think that many devs would use this class either, but I think it would be helpful to provide context in case a private repo or company plug-in is leveraging this class without our knowledge.
There was a problem hiding this comment.
I was planning on having that in the changelog, unless you think it needs to be in the typedoc too.
There was a problem hiding this comment.
These changes go a long way towards diffferentiating between those functions that we just happen to use and those functions that consumers are supposed to see.
I found one item which I do not think that we should hide from consumers. Check out my specific comment and see if you agree.
Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>
Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>
Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>
Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>
Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>
…ports Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>
packages/core/CHANGELOG.md
Outdated
| @@ -2,6 +2,11 @@ | |||
|
|
|||
| All notable changes to the Zowe core SDK package will be documented in this file. | |||
|
|
|||
| ## Recent Changes | |||
|
|
|||
| - LTS Breaking: Modified the core SDK. [#2083](https://github.com/zowe/zowe-cli/issues/2083) | |||
There was a problem hiding this comment.
In call changelog references, can we say why we're modifying the core SDK? For performance, for tech currency?
There was a problem hiding this comment.
The only modification made was to deprecate the IHeaderContent interface to remove duplication between the Core SDK and Imperative, which is captured on the next line. Would it be preferred to remove this line and only have the deprecation line?
Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>
Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>
…ports Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>
…ports Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>
|
|
Release succeeded for the The following packages have been published:
Powered by Octorelease 🚀 |
What It Does
Removes a set of exports that are not referenced outside of the related packages
Deprecates some functions/classes that are identical and appear twice in the codebase
This PR is presently in a draft state to get team opinions on additional things that can be removed. All of the items removed here did not appear outside of their respective packages. However, GitHub search only works against V2 LTS.
How to Test
Review Checklist
I certify that I have:
Additional Comments