[CLI] Improve warning message for source verification failure #13267
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
...when publishing or upgrading packages via the CLI. Improvements are as follows: - Preserve formatting in the error (newlines, etc) by removing debug formatting. - Add context explaining what the warning means, and that it can be ignored using a command-line flag. Test Plan: - Create two packages: `test` depending on `dep`. - Publish `dep`, and update its manifest with its published location. - Modify `dep`'s source to be different from the version that was published. - Try to publish `test`, expect a source verification error, which now looks like this: ``` Failed to publish the Move module(s), reason: [warning] Local dependency did not match its on-chain version at b33d80d795a038ce44d1f67b84047493f8775ab29d7f856271f705c6e1fd329f::Dep::dep This may indicate that the on-chain version(s) of your package's dependencies may behave differently than the source version(s) your package was built against. Fix this by rebuilding your packages with source versions matching on-chain versions of dependencies, or ignore this warning by re-running with the --skip-dependency-verification flag. ```
amnn
requested review from
rvantonder,
tedks,
tzakian,
randall-Mysten and
ronny-mysten
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
5 Ignored Deployments
|
|
Just thinking out loud - would it make sense to add a "force refetch" flag to the CLI? The cause of the issue usually is folks using "testnet" as a ref, and Move CLI does not refetch deps when a branch is specified (as in not commit hash). |
damirka
approved these changes
Aug 2, 2023
ronny-mysten
approved these changes
Aug 2, 2023
I need to understand this better: The default behaviour of the toolchain is to refetch remote (git) dependencies before you compile, and you need to use the |
ebmifa
pushed a commit
that referenced
this pull request
Aug 10, 2023
## Description ...when publishing or upgrading packages via the CLI. Improvements are as follows: - Preserve formatting in the error (newlines, etc) by removing debug formatting. - Add context explaining what the warning means, and that it can be ignored using a command-line flag. ## Test Plan - Create two packages: `test` depending on `dep`. - Publish `dep`, and update its manifest with its published location. - Modify `dep`'s source to be different from the version that was published. - Try to publish `test`, expect a source verification error, which now looks like this: ``` Failed to publish the Move module(s), reason: [warning] Local dependency did not match its on-chain version at b33d80d795a038ce44d1f67b84047493f8775ab29d7f856271f705c6e1fd329f::Dep::dep This may indicate that the on-chain version(s) of your package's dependencies may behave differently than the source version(s) your package was built against. Fix this by rebuilding your packages with source versions matching on-chain versions of dependencies, or ignore this warning by re-running with the --skip-dependency-verification flag. ``` --- 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) - [ ] protocol change - [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 The source verification failure warning from package publish and upgrade CLI commands has improved formatting and suggests ways to fix the issue or silence the warning.
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.
Description
...when publishing or upgrading packages via the CLI. Improvements are as follows:
Test Plan
testdepending ondep.dep, and update its manifest with its published location.dep's source to be different from the version that was published.test, expect a source verification error, which now looks like this: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
The source verification failure warning from package publish and upgrade CLI commands has improved formatting and suggests ways to fix the issue or silence the warning.