Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instructions on how to update Rustboard dependencies. #5757

Merged
merged 1 commit into from
Jun 15, 2022

Conversation

bmd3k
Copy link
Contributor

@bmd3k bmd3k commented Jun 13, 2022

Update instructions about how to update Rust dependencies, based on my experiences with #5755.

Notably:

  • Recommend using cargo update -p <dependency name> instead of cargo fetch when updating an existing dependency. cargo fetch will work when updating a dependency to a new major release but will not work when updating a dependency to a new minor release.
  • Recommend updating crate-specific metadata versions in Cargo.toml based on the update to crate versions in Cargo.lock. Do this before running cargo raze to avoid unnecessary confusion.
  • The targets to test are actually in //tensorboard/data/server/cargo. There do not appear to be valid targets in //third_party/rust.
  • Run bazel test tensorboard/data/server:update_protos_test to determine if the proto source files need to be updated. It's best to run this test first before attempting to test, build, and run the rest of the server, otherwise the error messages can be quite confusing.

@bmd3k bmd3k requested a review from nfelt June 13, 2022 15:54
Copy link
Contributor

@nfelt nfelt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, this is really great to have - appreciate your efforts to document what you learned!

@nfelt nfelt added core:rustboard //tensorboard/data/server/... rust Pull requests that update Rust code and removed rust Pull requests that update Rust code labels Jun 13, 2022
@bmd3k bmd3k changed the title Add instructions on how to update dependencies. Add instructions on how to update Rustboard dependencies. Jun 15, 2022
@bmd3k bmd3k merged commit 9c40e94 into tensorflow:master Jun 15, 2022
yatbear pushed a commit to yatbear/tensorboard that referenced this pull request Mar 27, 2023
…#5757)

Update instructions about how to update Rust dependencies, based on my experiences with tensorflow#5755.

Notably:
* Recommend using `cargo update -p <dependency name>` instead of `cargo fetch` when updating an existing dependency. `cargo fetch` will work when updating a dependency to a new major release but will not work when updating a dependency to a new minor release.
* Recommend updating crate-specific metadata versions in `Cargo.toml` based on the update to crate versions in `Cargo.lock`. Do this before running `cargo raze` to avoid unnecessary confusion.
* The targets to test are actually in `//tensorboard/data/server/cargo`. There do not appear to be valid targets in `//third_party/rust`.
* Run `bazel test tensorboard/data/server:update_protos_test` to determine if the proto source files need to be updated. It's best to run this test first before attempting to test, build, and run the rest of the server, otherwise the error messages can be quite confusing.
dna2github pushed a commit to dna2fork/tensorboard that referenced this pull request May 1, 2023
…#5757)

Update instructions about how to update Rust dependencies, based on my experiences with tensorflow#5755.

Notably:
* Recommend using `cargo update -p <dependency name>` instead of `cargo fetch` when updating an existing dependency. `cargo fetch` will work when updating a dependency to a new major release but will not work when updating a dependency to a new minor release.
* Recommend updating crate-specific metadata versions in `Cargo.toml` based on the update to crate versions in `Cargo.lock`. Do this before running `cargo raze` to avoid unnecessary confusion.
* The targets to test are actually in `//tensorboard/data/server/cargo`. There do not appear to be valid targets in `//third_party/rust`.
* Run `bazel test tensorboard/data/server:update_protos_test` to determine if the proto source files need to be updated. It's best to run this test first before attempting to test, build, and run the rest of the server, otherwise the error messages can be quite confusing.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core:rustboard //tensorboard/data/server/...
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants