Fix build for working with docs.rs #22
Merged
Conversation
This file contains hidden or 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
ifraixedes
force-pushed
the
if/issue-21
branch
10 times, most recently
from
b656367 to
0d6a0ea
Compare
docs.rs couldn't create the docs of uplink-sys crate because the build image that it uses doesn't have Go installed. Add the uplink-c binaries libraries for Linux x86_64 architecture, trick the build script to work differently when executed by docs.rs, and restrict docs.rs to only build the crate with this architecture works. Also update the Github workflow for verifying on each PR that the uplink-c lib binaries are up to date with the version that the git submodules references for not allowing to merge a PR without having them updated.
ifraixedes
added
type:enhancement
kmozurkewich
approved these changes
Jul 13, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
docs.rs couldn't create the docs of the uplink-sys crate because the
build image that it uses doesn't have Go installed. At the same time
this breaks the docs generation of any crate that depends on the
uplink-sys.
Add the uplink-c binaries libraries for Linux x86_64 architecture, trick
the build script to work differently when executed by docs.rs, and
restrict docs.rs to only build the crate with this architecture works.
Also, update the Github workflow for verifying on each PR that the
uplink-c lib binaries are up to date with the version that the
git submodules references for not allowing to merge a PR without having
them updated.
Closes #21
I've tested the changes with a local docs.rs environment and it worked, I hope that his will work in the production docs.rs.
mainbranch.