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

[ci] Fix broken "build docs" in nightly_docs.yml #538

Closed
notmandatory opened this issue Feb 2, 2022 · 3 comments · Fixed by #539
Closed

[ci] Fix broken "build docs" in nightly_docs.yml #538

notmandatory opened this issue Feb 2, 2022 · 3 comments · Fixed by #539
Assignees
Labels
ci discussion There's still a discussion ongoing documentation Improvements or additions to documentation

Comments

@notmandatory
Copy link
Member

notmandatory commented Feb 2, 2022

There is currently a regression in +nightly rustdocs that is breaking our CI docs build.

I believe this is caused by rust-lang/rust#93476

I think we have two options:

  1. For the docs CI jobs remove the --cfg docsrs flag and build docs with +stable
  2. Wait for rustdocs in +nightly to be fixed
@notmandatory notmandatory added ci discussion There's still a discussion ongoing documentation Improvements or additions to documentation labels Feb 2, 2022
@notmandatory
Copy link
Member Author

I prefer option 1, even though we won't see which feature is required to enable feature gated code, we can keep documenting it with the docsrs attribute and when the feature(doc_cfg) is available in +stable turn it back on.

If we take option 2 the issue may get fixed in the next few days but we can still run into some other regression in a future +nightly and will have our CI randomly broken again.

@notmandatory notmandatory self-assigned this Feb 2, 2022
@notmandatory notmandatory moved this to Todo in BDK Maintenance Feb 2, 2022
@notmandatory notmandatory changed the title [CI] Use +stable for rustdocs and disable feature(doc_cfg) until available in +stable [CI] Fix broken "build docs" in Publish nightly_docs.yml Feb 2, 2022
@notmandatory notmandatory changed the title [CI] Fix broken "build docs" in Publish nightly_docs.yml [CI] Fix broken "build docs" in nightly_docs.yml Feb 2, 2022
@afilini
Copy link
Member

afilini commented Feb 4, 2022

Maybe a third option is to pin a specific nightly version that we know is working fine?

It's not the end of the world to lose the doc_cfg feature, but I would like to replicate the environment in docs.rs as much as we can, so that we can see if anything is wrong before publishing a release

@notmandatory
Copy link
Member Author

Good idea! I forgot we can use specific nightly builds. I'll put together a PR to do that.

@notmandatory notmandatory moved this from Todo to Ready to Review in BDK Maintenance Feb 4, 2022
@notmandatory notmandatory changed the title [CI] Fix broken "build docs" in nightly_docs.yml [ci] Fix broken "build docs" in nightly_docs.yml Feb 4, 2022
@afilini afilini closed this as completed in e745122 Feb 7, 2022
Repository owner moved this from Ready to Review to Done in BDK Maintenance Feb 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci discussion There's still a discussion ongoing documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants