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

Document that Cargo is prerequisite to build Zowe CLI #1774

Closed
t1m0thyj opened this issue Aug 2, 2023 · 2 comments
Closed

Document that Cargo is prerequisite to build Zowe CLI #1774

t1m0thyj opened this issue Aug 2, 2023 · 2 comments
Labels
bug Something isn't working dev-doc good first issue Good for newcomers priority-low Legit issue but cosmetic or nice-to-have severity-medium Bug where workaround exists or that doesn't prevent the usage of Zowe. Just makes it more complex.

Comments

@t1m0thyj
Copy link
Member

t1m0thyj commented Aug 2, 2023

Ever since the "zowex" folder was added for the Zowe CLI daemon, Cargo has been required to build it.
But building the daemon is optional for CLI contributors and not part of the npm run build script.

Now that we have added the Secrets SDK as package in this repo, Cargo is required for npm run build to work.
The reason is that we build Rust bindings to access the native OS APIs for secure credential storage.

Therefore, we should document in the readme that cargo as a prerequisite for building Zowe CLI from source.
It can be downloaded here: https://rustup.rs/

@t1m0thyj t1m0thyj added bug Something isn't working good first issue Good for newcomers priority-low Legit issue but cosmetic or nice-to-have severity-medium Bug where workaround exists or that doesn't prevent the usage of Zowe. Just makes it more complex. dev-doc labels Aug 2, 2023
@t1m0thyj t1m0thyj changed the title Document that Cargo is prerequisite for Zowe CLI Document that Cargo is prerequisite to build Zowe CLI Aug 2, 2023
@github-actions
Copy link

github-actions bot commented Aug 2, 2023

Thank you for creating a bug report.
We will investigate the bug and evaluate its impact on the product.
If you haven't already, please ensure you have provided steps to reproduce the bug and as much context as possible.

@traeok
Copy link
Member

traeok commented Oct 2, 2023

Initial research shows that the MSRV (Minimum Supported Rust Version) for the Secrets SDK is 1.70.0, which is also the matching Cargo version - we can mention that Cargo/Rust v1.70 is the minimum supported toolchain.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working dev-doc good first issue Good for newcomers priority-low Legit issue but cosmetic or nice-to-have severity-medium Bug where workaround exists or that doesn't prevent the usage of Zowe. Just makes it more complex.
Projects
None yet
Development

No branches or pull requests

3 participants