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

Deprecate old getDataSet in v2 LTS, move to zosfiles SDK #1977

Merged
merged 5 commits into from
Nov 28, 2023

Conversation

awharn
Copy link
Member

@awharn awharn commented Nov 28, 2023

What It Does
Copies getDataSet to the zosFiles SDK under the new name, and deprecates the original function

How to Test

Review Checklist
I certify that I have:

Additional Comments

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>
Comment on lines +17 to 20
* @deprecated - use @zowe/zos-files-for-zowe-sdk's ZosFilesUtils.getDataSetFromName instead
* Converts the name of a data set to an IDataSet
* @param {string} name - the name in the form USER.DATA.SET | USER.DATA.SET(mem1)
*/
Copy link
Member

Choose a reason for hiding this comment

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

Alongside the deprecation message, should we call the getDataSetFromName method here?
That way, if there is ever a bug in the method, we can fix in in one place? 😋

I don't think doing this will cause a circular dependency since the CLI package already imports the files sdk 😋

Copy link
Member

Choose a reason for hiding this comment

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

👍

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

Copy link

codecov bot commented Nov 28, 2023

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (5549c8e) 91.04% compared to head (84ead1b) 91.03%.

Files Patch % Lines
packages/cli/src/zosfiles/ZosFiles.utils.ts 0.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1977      +/-   ##
==========================================
- Coverage   91.04%   91.03%   -0.02%     
==========================================
  Files         636      636              
  Lines       18712    18713       +1     
  Branches     3898     3898              
==========================================
- Hits        17037    17035       -2     
- Misses       1674     1677       +3     
  Partials        1        1              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@gejohnston gejohnston left a comment

Choose a reason for hiding this comment

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

Approve after Fernando's comment is addressed.

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>
@awharn awharn requested a review from zFernand0 November 28, 2023 18:04
Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

85.7% 85.7% Coverage
0.0% 0.0% Duplication

@zFernand0 zFernand0 merged commit 5f4c989 into master Nov 28, 2023
@zFernand0 zFernand0 deleted the deprecate-getDataSet branch November 28, 2023 19:00
@zFernand0 zFernand0 added the release-minor Indicates a minor feature has been added label Nov 28, 2023
Copy link

Release succeeded for the master branch. 🎉

The following packages have been published:

  • npm: @zowe/zos-files-for-zowe-sdk@7.20.0
  • npm: @zowe/zos-workflows-for-zowe-sdk@7.20.0
  • npm: @zowe/zos-jobs-for-zowe-sdk@7.20.0
  • npm: @zowe/cli@7.20.0

Powered by Octorelease 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-minor Indicates a minor feature has been added released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants