refactor(app/core): build.rs prints invalid proxy version#3482
Merged
Conversation
if this build script panics due to an invalid proxy version environment variable, the panic can be somewhat cryptic. a message saying `LINKERD2_PROXY_VERSION must be semver` is printed, but the proxy version that caused this is not shown. this commit adds the version and the error to this panic message. now, building with an invalid proxy version provides us with the following: ``` ; LINKERD2_PROXY_VERSION='invalid' cargo build -p linkerd-app-core Compiling linkerd-app-core v0.1.0 (/linkerd2-proxy/linkerd/app/core) error: failed to run custom build command for `linkerd-app-core v0.1.0 (/linkerd2-proxy/linkerd/app/core)` note: To improve backtraces for build dependencies, set the CARGO_PROFILE_DEV_BUILD_OVERRIDE_DEBUG=true environment variable to enable debug information generation. Caused by: process didn't exit successfully: `/linkerd2-proxy/target/debug/build/linkerd-app-core-756fc82028bfbcc0/build-script-build` (exit status: 101) --- stdout cargo:rustc-env=GIT_SHA=e53b6b9d cargo:rustc-env=LINKERD2_PROXY_BUILD_DATE=2024-12-20T01:18:08Z --- stderr thread 'main' panicked at linkerd/app/core/build.rs:18:17: LINKERD2_PROXY_VERSION must be semver: version='invalid' error='unexpected character 'i' while parsing major version number' ``` Signed-off-by: katelyn martin <kate@buoyant.io>
This was referenced Dec 20, 2024
sfleen
approved these changes
Dec 20, 2024
alpeb
approved these changes
Dec 20, 2024
This file contains hidden or 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
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.
if this build script panics due to an invalid proxy version environment variable, the panic can be somewhat cryptic. a message saying
LINKERD2_PROXY_VERSION must be semveris printed, but the proxy version that caused this is not shown.this commit adds the version and the error to this panic message.
now, building with an invalid proxy version provides us with the following: