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

Make mithril-client examples full crates #1379

Merged
merged 5 commits into from
Dec 5, 2023

Conversation

dlachaume
Copy link
Collaborator

@dlachaume dlachaume commented Nov 30, 2023

Content

This PR includes the creation of a dedicated crate for each example of the mithril-client library.

This enhance the DevX for developers that want to implement the library in their own projects. Then now have precisely all the dependencies needed to run the examples.

Pre-submit checklist

  • Branch
    • Tests are provided (if possible)
    • Crates versions are updated (if relevant)
    • Commit sequence broadly makes sense
    • Key commits have useful messages
  • PR
    • No clippy warnings in the CI
    • Self-reviewed the diff
    • Useful pull request description
    • Reviewer requested
  • Documentation
    • Update README file (if relevant)
    • Update documentation website (if relevant)
    • Add dev blog post (if relevant)

Issue(s)

Closes #1385

@dlachaume dlachaume force-pushed the damien/make-mithril-client-examples-full-crates branch 2 times, most recently from 808e1b2 to f3c62ad Compare November 30, 2023 17:41
Copy link

github-actions bot commented Nov 30, 2023

Test Results

    3 files  ±0    30 suites  ±0   7m 38s ⏱️ +13s
745 tests ±0  745 ✔️ ±0  0 💤 ±0  0 ±0 
853 runs  ±0  853 ✔️ ±0  0 💤 ±0  0 ±0 

Results for commit 0941327. ± Comparison against base commit e0722cb.

♻️ This comment has been updated with latest results.

@dlachaume dlachaume self-assigned this Nov 30, 2023
@dlachaume dlachaume force-pushed the damien/make-mithril-client-examples-full-crates branch from f3c62ad to 901ca66 Compare December 1, 2023 08:12
Copy link
Member

@jpraynaud jpraynaud left a comment

Choose a reason for hiding this comment

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

Comments seen together!

Cargo.toml Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
@dlachaume dlachaume force-pushed the damien/make-mithril-client-examples-full-crates branch 2 times, most recently from 34c1cd1 to 74cc66f Compare December 1, 2023 11:09
examples/client-mithril-stake-distribution/README.md Outdated Show resolved Hide resolved
Cargo.toml Outdated Show resolved Hide resolved
@dlachaume dlachaume force-pushed the damien/make-mithril-client-examples-full-crates branch from 74cc66f to 969eff9 Compare December 4, 2023 11:34
@dlachaume dlachaume force-pushed the damien/make-mithril-client-examples-full-crates branch 3 times, most recently from 3d4baa8 to 3a0c89b Compare December 4, 2023 13:46
@dlachaume dlachaume marked this pull request as ready for review December 4, 2023 13:47
@dlachaume dlachaume force-pushed the damien/make-mithril-client-examples-full-crates branch from 297f4c1 to ac9b9d5 Compare December 4, 2023 16:47
Copy link
Member

@jpraynaud jpraynaud left a comment

Choose a reason for hiding this comment

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

LGTM 👍

Just few typos to fix

examples/client-mithril-stake-distribution/README.md Outdated Show resolved Hide resolved
@dlachaume dlachaume force-pushed the damien/make-mithril-client-examples-full-crates branch from ac9b9d5 to 8451092 Compare December 4, 2023 17:44
Two seperates crates were created:
- `client-snapshot`
- `client-mithril-stake-distribution`
+ Fix developer documentation link
@dlachaume dlachaume force-pushed the damien/make-mithril-client-examples-full-crates branch from 8451092 to ea49e91 Compare December 5, 2023 11:37
This PR updates the `default` feature flag of `mithril-client`
@dlachaume dlachaume merged commit a3d53a7 into main Dec 5, 2023
34 checks passed
@dlachaume dlachaume deleted the damien/make-mithril-client-examples-full-crates branch December 5, 2023 12:37
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.

Make mithril-client examples full crates
3 participants