full package history #47
Open
+920
−63
Conversation
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
…y using a Move.package-history.toml file The `Move.package-history.toml` file * should be located in the same directory as the `Move.lock` file * contains all necessary data * can be maintained manually or by using a package-history CLI tool
….package-history.toml` files
4 tasks
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
… in package_history_cli/src/main.rs to be used by build.rs scripts of product repositories Crate package_history_cli has been removed
… can ignore envs specified by their alias
…d in build.rs implementations
UMR1352
requested changes
Aug 12, 2025
| /// # Errors | ||
| /// This method may return errors from the underlying `init()` or `update()` functions | ||
| /// if there are issues reading or writing files. | ||
| pub fn manage_history_file(&self, console_out: impl Fn(String)) -> anyhow::Result<()> { |
There was a problem hiding this comment.
instead of an impl Fn(String) maybe it'd be better to use &mut impl std::fmt::Write
Comment on lines
213
to
236
| if self.move_lock_file_exists() { | ||
| if self.history_file_exists() { | ||
| // If the output file already exists, update it. | ||
| console_out(format!("File `{move_history_path}` already exists, updating...")); | ||
| self | ||
| .update() | ||
| .expect("Successfully updating `Move.history.json` file with `Move.lock` content"); | ||
| console_out(format!( | ||
| "Successfully updated`{move_history_path}` with content of `{move_lock_path}`" | ||
| )); | ||
| } else { | ||
| // If the output file does not exist, create it. | ||
| console_out(format!("File `{move_history_path}` does not exist, creating...")); | ||
| self | ||
| .init() | ||
| .expect("Successfully creating a `Move.history.json` file with `Move.lock` content"); | ||
| console_out(format!( | ||
| "Successfully created file `{move_history_path}` with content of `{move_lock_path}` content" | ||
| )); | ||
| } | ||
| } else { | ||
| console_out(format!("File `{move_history_path}` does not exist, skipping...")); | ||
| } | ||
| Ok(()) |
There was a problem hiding this comment.
Reduce nesting with early returns
| /// | ||
| /// Doesn't check if any of the provided paths are invalid or if the `Move.lock` file cannot be parsed. | ||
| /// Functions `init` and `update` will handle those checks. | ||
| pub fn new(move_lock_path: &Path, history_file_path: &Path, aliases_to_ignore: Option<Vec<String>>) -> Self { |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
| console_out(format!("File `{move_history_path}` does not exist, creating...")); | ||
| self | ||
| .init() | ||
| .expect("Successfully creating a `Move.history.json` file with `Move.lock` content"); |
There was a problem hiding this comment.
How can you be sure this doesn't fail? I'd probably just forward the error
There was a problem hiding this comment.
Right, has been a relict from a former version where this code has been placed in the build.rs file
* Narrow down serde_json Value to type String to avoid the need for fn `remove_first_and_last_char_from_string` * Use anyhow `with_context` instead `context` where `format!` is used * Use `serde_json::to_string_pretty` to avoid the need for fn `to_prettified_string`
itsyaasir
approved these changes
Aug 14, 2025
…default `aliases_to_watch` list
# Conflicts: # Cargo.toml # product_common/Cargo.toml
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 of change
product_common::PackageRegistrynow supports the full package version history. It uses aMove.history.jsonfile to import the version history and known environments (as being previously done withMove.lockfiles).The
Move.history.jsonfileMove.lockfilePackageRegistryPackageRegistryinclude_str!()) - like the previously usedMove.lockfile had been integrated in the buildlocalnetnetworks, as this would mass up the file. For this purpose theMoveHistoryManagerdescribed below, offers aaliases_to_ignorelist which is set tolocalnetper default.For example the
Move.history.jsonfor the recent (not latest) Identity package would look like this:{ "aliases": { "devnet": "e678123a", "testnet": "2304aa97", "mainnet": "6364aad5" }, "envs": { "6364aad5": ["0x84cf5d12de2f9731a89bb519bc0c982a941b319a33abefdd5ed2054ad931de08"], "e678123a": [ "0xe6fa03d273131066036f1d2d4c3d919b9abbca93910769f26a924c7a01811103", "0x6a976d3da90db5d27f8a0c13b3268a37e582b455cfc7bf72d6461f6e8f668823" ], "2304aa97": [ "0x222741bbdff74b42df48a7b4733185e9b24becb8ccfbafe8eac864ab4e4cc555", "0x3403da7ec4cd2ff9bdf6f34c0b8df5a2bd62c798089feb0d2ebf1c2e953296dc" ] } }Product
build.rsscriptsThe
Move.history.jsonfor a product can be created manually or automatically using theMoveHistoryManagerinbuils.rsscripts .See the docs of the MoveHistoryManager for further details.
An example for a build.rs script using the
MoveHistoryManagerto manage itsMove.history.jsonfile can be found in the Notarization - Full package history PR.Links to any relevant issues
Will fix: NOTARIZATION_PACKAGE_REGISTRY: Support full package address version history #71