[move-package] Support dependency overrides#11181
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ |
amnn
approved these changes
Apr 21, 2023
Contributor
amnn
left a comment
amnn
left a comment
There was a problem hiding this comment.
Stamping as reviewed on move-language/move
6 tasks
awelc
added a commit
that referenced
this pull request
Apr 25, 2023
## Description A description of how recently landed (#11181) dependency overrides work. Please let me know if you need this changes, extended, etc. I am also not sure if this should be a separate file (as it is intended for now) or if it should be folded into an existing document (e.g., https://github.com/MystenLabs/sui/blob/main/doc/src/build/package-upgrades.md), and if the former is the case, if there is any additional work required to have it properly displayed on the developer portal. ## Test Plan It's just the docs --- If your changes are not user-facing and not a breaking change, you can skip the following section. Otherwise, please indicate what changed, and then add to the Release Notes section as highlighted during the release process. ### Type of Change (Check all that apply) - [x] user-visible impact - [ ] breaking change for a client SDKs - [ ] breaking change for FNs (FN binary must upgrade) - [ ] breaking change for validators or node operators (must upgrade binaries) - [ ] breaking change for on-chain data layout - [ ] necessitate either a data wipe or data migration ### Release notes --------- Co-authored-by: ronny-mysten <118224482+ronny-mysten@users.noreply.github.com> Co-authored-by: Ashok Menon <ashok@mystenlabs.com>
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
2 participants
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.
Description
When building a dependency graph, different versions of the same (transitively) dependent package can be encountered. If this is indeed the case, a single version must be chosen by the developer to be the override, and this override must be specified in a manifest file whose package dominates all the conflicting "uses" of the dependent package. These overrides must taken into consideration during the dependency graph construction and this PR implements the relevant changes to dependency graph construction algorithm. For additional details see the doc-comments in the code as well as the PR this one is based on (move-language/move#1023) which contains a discussion of issues encountered during development of this algorithm.
Test Plan
A comprehensive test suite is attached.
If your changes are not user-facing and not a breaking change, you can skip the following section. Otherwise, please indicate what changed, and then add to the Release Notes section as highlighted during the release process.
Type of Change (Check all that apply)
Release notes
This change allows a developer to override transitive dependencies of a package they are developing to avoid conflicts that could otherwise arise.