Skip to content
This repository has been archived by the owner on Dec 9, 2023. It is now read-only.

do not build shell code on docs.rs #224

Merged
merged 1 commit into from
Dec 18, 2022
Merged

Conversation

zoedberg
Copy link
Contributor

I've just noticed that also rgb-node documentation build fails.

This PR applies the same fix proposed here Storm-WG/storm-stored#8

@dr-orlovsky probably before releasing a v0.8.2 it's better if I check if there are other libraries we depend on that need the same fix, I'll let you know

Copy link
Member

@dr-orlovsky dr-orlovsky left a comment

Choose a reason for hiding this comment

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

ACK d1c8a56

Thank you for fixing! Can I release v0.8.2 or you need more testing before that?

@dr-orlovsky dr-orlovsky merged commit dcf6664 into RGB-WG:v0.8 Dec 18, 2022
@zoedberg
Copy link
Contributor Author

@dr-orlovsky I've just checked all rgb-node and rgb-lib dependencies on https://docs.rs/ and I've found only another library, lnp-core, for which documentation build fails. I think that we need to fix that before releasing a v0.8.2. The issue in lnp-core seems different from the one in rgb-node and store-daemon so I need a little more time to investigate that

@zoedberg zoedberg mentioned this pull request Dec 18, 2022
@dr-orlovsky
Copy link
Member

It seems that the problem was caused by releasing the library without --all-features. What you propose is to enable all features by default, which is incorrect (it is ok for the crate to have a non-default features; a lot of such crates build on docs.rs). I will try to do a release with --all-features and nothing else changed - lets see would it help. Another option is to add

[package.metadata.docs.rs]
features = ["all"]

to the Cargo.toml, which I think will be a good solution for all our crates

@dr-orlovsky
Copy link
Member

Fixed lnp-core/lnp2p and released v0.8.1 versions of both of them. Can you pls check now is everything works?

@zoedberg
Copy link
Contributor Author

@dr-orlovsky lnp-core documentation build still fails: https://docs.rs/crate/lnp-core/0.8.1/builds/704364

@dr-orlovsky
Copy link
Member

That is strange. Had to read all rustdoc and docrs manuals, tried my best in LNP-WG/lnp-core#18. Let's see how that would work

@dr-orlovsky
Copy link
Member

Holy cow, the docrs build finally worked!

@zoedberg
Copy link
Contributor Author

That's great! Thank you ❤️

@dr-orlovsky
Copy link
Member

Pls let me know if I can publish rgb-node v0.8.2

@zoedberg
Copy link
Contributor Author

@dr-orlovsky I think you can go

@dr-orlovsky
Copy link
Member

v0.8.2 released

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants