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

Add note about Cargo build requirement #1834

Merged
merged 4 commits into from
Oct 30, 2023
Merged

Conversation

adam-wolfe
Copy link
Contributor

What It Does
Adds information to README.md stating that Cargo 1.72.0 (or newer) is required in order to build Zowe CLI from source.

How to Test
Check README.md at the root of the repository and in packages/cli/README.md.

Review Checklist
I certify that I have:

Additional Comments

@codecov
Copy link

codecov bot commented Oct 26, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

see 1 file with indirect coverage changes

📢 Thoughts on this report? Let us know!.

@sonarqubecloud
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

No Coverage information No Coverage information
No Duplication information No Duplication information

Copy link
Member

@zFernand0 zFernand0 left a comment

Choose a reason for hiding this comment

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

Left a small comment, but LGTM! 😋

README.md Outdated
@@ -49,7 +49,7 @@ Versioning conventions for Zowe CLI and Plug-ins| [Versioning Guidelines](./docs
<br/>

## **Building Zowe CLI From Source**
Zowe CLI requires NPM version 7 to install from source. Before proceeding, check your NPM version with `npm --version` and if it's older than 7.x, update with `npm install -g npm`.
Zowe CLI requires NPM version 7 and Cargo version 1.72.0 (or newer) to build from source. Before proceeding, check your NPM version with `npm --version` and if it's older than 7.x, update with `npm install -g npm`. To check your version of Cargo, run `cargo --version`. Cargo can be installed using rustup: [https://rustup.rs/](https://rustup.rs/). To update Cargo, run the `rustup update` command.
Copy link
Member

Choose a reason for hiding this comment

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

is it ok to modify the npm version number to at least 8?
Nobody should be using anything lower than 9 at this point since Node started to bundle 9 with node 18 😋
https://nodejs.org/en/download/releases

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed.

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

@zFernand0 zFernand0 left a comment

Choose a reason for hiding this comment

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

thanks for addressing the comment 😋
LGTM! 😋

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 @adam-wolfe!

@adam-wolfe adam-wolfe merged commit 29d0d7d into master Oct 30, 2023
42 checks passed
@adam-wolfe adam-wolfe deleted the add-cargo-req-note branch October 30, 2023 15:41
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.

5 participants