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

fix: install cargo udeps differently #82

Merged
merged 1 commit into from
May 1, 2024

Conversation

giladchase
Copy link
Collaborator

@giladchase giladchase commented May 1, 2024

  • instead of compiling from source, use a cached cargo install github action (which appears to be cached by default!), and then run udeps from cargo.

  • this is the recommended installation method from udeps' readme.

  • motivation: Previous method of installation seemed to hit compilation errors [here] (https://reviewable.io/reviews/starkware-libs/mempool/42#-), that weren't reproducible when running through cargo udeps.

  • NOTE: The github action used for cargo-install only has ~100 stars, which isn't a lot, but I found a few well-used projects that use them, like tokio-rs/prost and wez/wezterm, so it's probably OK.

  • ALTERNATIVE: switching from udeps to machete. The cairo team did and they're pleased with the results.


This change is Reviewable

@giladchase giladchase force-pushed the gilad/change-udeps-installation branch from 94c26d6 to 1e87f91 Compare May 1, 2024 07:31
@codecov-commenter
Copy link

codecov-commenter commented May 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 54.54%. Comparing base (27b550e) to head (7d4c1fb).

❗ Current head 7d4c1fb differs from pull request most recent head 3a396a7. Consider uploading reports for the commit 3a396a7 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #82   +/-   ##
=======================================
  Coverage   54.54%   54.54%           
=======================================
  Files          11       11           
  Lines         275      275           
  Branches      275      275           
=======================================
  Hits          150      150           
  Misses        123      123           
  Partials        2        2           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@giladchase giladchase force-pushed the gilad/change-udeps-installation branch 2 times, most recently from 817d7bc to 2743e43 Compare May 1, 2024 07:37
@giladchase giladchase force-pushed the gilad/change-udeps-installation branch 4 times, most recently from 8d67c2a to c80e291 Compare May 1, 2024 08:03
- Instead of compiling from source, use a cached cargo install github action
(which appears to be cached by default!), and then run udeps from cargo.
- This is the recommended installation method from udeps' readme.
- Motivation: Previous method of installation seemed to hit compilation errors
[here] (https://reviewable.io/reviews/starkware-libs/mempool/42#-),
that weren't reproducible when running through cargo udeps.
- NOTE: The github action used for cargo-install only has ~100 stars, which isn't a lot,
but I found a few well-used projects that use them, like tokio-rs/prost and wez/wezterm,
so it's probably OK.
- ALTERNATIVE: switching from udeps to machete. The cairo team did and they're pleased
with the results.
@giladchase giladchase force-pushed the gilad/change-udeps-installation branch 6 times, most recently from 7d4c1fb to 3a396a7 Compare May 1, 2024 09:21
Copy link
Collaborator Author

@giladchase giladchase left a comment

Choose a reason for hiding this comment

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

ALTERNATIVE: switching from udeps to machete. The cairo team did and they're pleased with the results.

@elintul thinks we should consider moving to machete, it is faster and should be less vulnerable to bugs like the one we hit.
Machete doesn't compile the repo like udeps (which is why it's less vulnerable to compilation issues), it just greps for missing dependencies, which they do surprisingly well according to compiler team.

Reviewable status: 0 of 1 files reviewed, all discussions resolved (waiting on @dafnamatsry and @Yael-Starkware)

Copy link
Contributor

@Yael-Starkware Yael-Starkware left a comment

Choose a reason for hiding this comment

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

Reviewed 1 of 1 files at r1, all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @dafnamatsry)

@Yael-Starkware Yael-Starkware merged commit ddecb8d into main May 1, 2024
15 checks passed
@Yael-Starkware Yael-Starkware deleted the gilad/change-udeps-installation branch May 1, 2024 12:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants