cargo-build-sbf: Use metadata.solana.tools-version in Cargo.toml
#2914
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
joncinque
force-pushed
the
toolstoml
branch
from
1687df1 to
6e61142
Compare
febo
reviewed
Sep 13, 2024
| let package_tools_version = package.metadata.get("solana").and_then(|v| v.get("tools-version")).and_then(|v| v.as_str()); | ||
| match (workspace_tools_version, package_tools_version) { | ||
| (Some(workspace_version), Some(package_version)) => { | ||
| if workspace_version != package_version { |
There was a problem hiding this comment.
Nice! I was going to ask if there was a precedence between the versions.
joncinque
force-pushed
the
toolstoml
branch
from
c603f40 to
684cc45
Compare
|
The PR looks good. Should we have a test for this new behavior? |
Sure! I added a test for the package version and the workspace version, let me know how it looks. |
joncinque
force-pushed
the
toolstoml
branch
from
9b1c639 to
5d2966d
Compare
LucasSte
approved these changes
Sep 26, 2024
#### Problem It's possible to specify the version of the platform-tools version using the `--tools-version`, but most people aren't aware of the different versions of the compiler, or that they can use the flag. #### Summary of changes Allow `cargo-build-sbf` to read from the metadata section of a package or workspace Cargo.toml. The concept is similar to `rust-toolchain.toml`, where cargo finds the right version of Rust. For cargo-build-sbf, it can read: ```toml [package.metadata.solana] tools-version = "v1.43" ``` Or ```toml [workspace.metadata.solana] tools-version = "v1.43" ``` To go with this change, since I often forget leading "v" in the version string, the version parsing now allows for omitting the leading "v", so you can specify `--tools-version 1.43`.
joncinque
added
the
automerge
ray-kast
pushed a commit
to abklabs/agave
that referenced
this pull request
Nov 27, 2024
…nza-xyz#2914) * cargo-build-sbf: Use `solana.tools-version` in Cargo.toml #### Problem It's possible to specify the version of the platform-tools version using the `--tools-version`, but most people aren't aware of the different versions of the compiler, or that they can use the flag. #### Summary of changes Allow `cargo-build-sbf` to read from the metadata section of a package or workspace Cargo.toml. The concept is similar to `rust-toolchain.toml`, where cargo finds the right version of Rust. For cargo-build-sbf, it can read: ```toml [package.metadata.solana] tools-version = "v1.43" ``` Or ```toml [workspace.metadata.solana] tools-version = "v1.43" ``` To go with this change, since I often forget leading "v" in the version string, the version parsing now allows for omitting the leading "v", so you can specify `--tools-version 1.43`. * Relax leading "v" * Add CHANGELOG entry * Special-case default run * Add tests * ci: Fix parsing platform tools version
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
It's possible to specify the version of the platform-tools version using
the
--tools-version, but most people aren't aware of the differentversions of the compiler, or that they can use the flag.
Summary of changes
Allow
cargo-build-sbfto read from the metadata section of a packageor workspace Cargo.toml. The concept is similar to
rust-toolchain.toml, where cargo finds the right version of Rust. Forcargo-build-sbf, it can read:
Or
To go with this change, since I often forget leading "v" in the version
string, the version parsing now allows for omitting the leading "v", so
you can specify
--tools-version 1.43.As follow-up work, I would like to make
cargo build-sbf --versionshowthe appropriate version based on the Cargo.toml /
--tools-versionarg,same as
cargodoes.cc @lorisleiva and @febo