This repository has been archived by the owner on Oct 19, 2024. It is now read-only.
fix: docsrs builds final #2235
Merged
fix: docsrs builds final #2235
Conversation
This file contains 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
mattsse
reviewed
Mar 6, 2023
Comment on lines
+46
to
+57
| #[doc(hidden)] | ||
| #[allow(unused_extern_crates)] | ||
| extern crate self as ethers; | ||
|
|
||
| #[doc(hidden)] | ||
| pub use ethers_contract as contract; | ||
|
|
||
| #[doc(hidden)] | ||
| pub use ethers_core as core; | ||
|
|
||
| #[doc(hidden)] | ||
| pub use ethers_providers as providers; |
There was a problem hiding this comment.
hmm, I'm not sure I like that these are now always there.
There was a problem hiding this comment.
if you have a better way to find ethers crate names then go ahead, this is a patch for builds when that is not possible, and only for our internal crates
There was a problem hiding this comment.
I don't have a better solution for this, and seems like this is a proper fix.
But let's document why we're doing this
gakonst
approved these changes
Mar 8, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Motivation
For some reason (I believe because the build process isn't normal and maybe our resolution doesn't work with the given environment) the docs.rs builds always return
ethersas the crate name (default). Tested multiple times on a local docs.rs instance and I can 99.9999999% confirm that this PR solves it by doing the following:ethers#[cfg(docsrs)]on the re-exports)cfgs, just to be safethis needs to be done in every (release) crate that uses a macro that uses
ethers_core::macros::*, which right now includes contract and middleware.Solution
PR Checklist