This repository has been archived by the owner on Nov 20, 2023. It is now read-only.
Disambiguate the names of the Rust client crates. #126
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
|
|
This is a breaking change, as it renames the two `nomad_client` crates and thus every symbol exported by either of them. Cargo's `git` dependency resolution is able to locate crates in subdirectories of a Git repository, so long as the crate names are unique within the repo[1]. Unfortunately, the existing crates are both named `nomad_client`, which is ambiguous and causes Cargo to arbitrarily pick one when resolving the crate. This change distinguishes the crates so that they have distinct names, allowing clients to pick the crate and depend on it directly from Git. The option to vendor the crate remains open, but it's no longer strictly required, which simplifies dependency upgrades a bit (`cargo upgrade` can update the commit hash, for example). Publishing these crates to crates.io for general use is beyond the scope of this change. [1]: rust-lang/cargo#1462
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This is a breaking change, as it renames the two
nomad_clientcrates and thus every symbol exported by either of them.Cargo's
gitdependency resolution is able to locate crates in subdirectories of a Git repository, so long as the crate names are unique within the repo. Unfortunately, the existing crates are both namednomad_client, which is ambiguous and causes Cargo to arbitrarily pick one when resolving the crate.This change distinguishes the crates so that they have distinct names, allowing clients to pick the crate and depend on it directly from Git. The option to vendor the crate remains open, but it's no longer strictly required, which simplifies dependency upgrades a bit (
cargo upgradecan update the commit hash, for example).Publishing these crates to crates.io for general use is beyond the scope of this change. However, please consider that as an alternative way of resolving this pull request.