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

Fix plug-in peerDep check #2067

Merged
merged 5 commits into from
Mar 6, 2024
Merged

Fix plug-in peerDep check #2067

merged 5 commits into from
Mar 6, 2024

Conversation

zFernand0
Copy link
Member

@zFernand0 zFernand0 commented Feb 26, 2024

What It Does

Remove the warnings at plug-in install time that appear, even though the plug-in peerDep version-range satisfies the requirement.

How to Test

First you would want to reproduce the issue:

  • Globally install any of the CLI versions tagged as 7.0.0-next.###
  • Modify a plug-in's peerDep version of imperative to >=5.0.0-next.0 <5.0.0.
  • Install your plug-in
  • Notice that there is a warning at install time

Then you can test this branch:

  • Build this branch and install/link it globally
  • Update the plug-in peerDep version to >=8.0.0-next.0 <8.0.0
  • Install the plug-in
  • Notice that there is no warning at install time 😋

Review Checklist
I certify that I have:

Additional Comments

This follows the same behavior as https://semver.npmjs.com/

  • Feel free to go to the website and enter the values @zowe/imperative and >=5.0.0-next.0 <5.0.0 😋

Also, this GIF might make things easier to review:
temp

Signed-off-by: zFernand0 <[email protected]>
Copy link

codecov bot commented Feb 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.93%. Comparing base (b840120) to head (2e1d2d0).
Report is 1 commits behind head on next.

Additional details and impacted files
@@           Coverage Diff           @@
##             next    #2067   +/-   ##
=======================================
  Coverage   90.93%   90.93%           
=======================================
  Files         616      616           
  Lines       17359    17359           
  Branches     3671     3672    +1     
=======================================
  Hits        15786    15786           
  Misses       1572     1572           
  Partials        1        1           

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

Copy link
Member

@traeok traeok left a comment

Choose a reason for hiding this comment

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

Had a couple suggestions about phrasing in typedoc 🙂

Signed-off-by: zFernand0 <[email protected]>
Copy link
Member

@t1m0thyj t1m0thyj left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @zFernand0!

@awharn awharn requested a review from traeok February 26, 2024 19:20
Copy link
Member

@traeok traeok left a comment

Choose a reason for hiding this comment

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

LGTM - thanks @zFernand0!

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.

My only comment is on the example in the PR description.

A range of >=5.0.0-next.0 <5.0.0 would only permit the use pre-release versions. I think it would fail when that version becomes GA (5.0.0).

I think in practice, that a range of >=5.0.0-next.0 <6.0.0 would permit pre-release versions of 5.0.0, and permit every GA version of 5.x, but not permit any 6.x version.

@zFernand0
Copy link
Member Author

This PR can wait until after to following PR is merged into next to avoid any confusion/conflicts 😋

Base automatically changed from rm-profile-handlers to next March 1, 2024 18:33
Copy link

sonarqubecloud bot commented Mar 6, 2024

@zFernand0 zFernand0 merged commit 9334d66 into next Mar 6, 2024
47 checks passed
@zFernand0 zFernand0 deleted the fix/peer-dep-check branch March 6, 2024 15:11
Copy link

github-actions bot commented Mar 6, 2024

Release succeeded for the next branch. 🎉

The following packages have been published:

Powered by Octorelease 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants