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
[INFRA] Configure doc build CI to always host artifacts #3990
Conversation
👋 @ymzayek Thanks for creating a PR! Until this PR is ready for review, you can include the [WIP] tag in its title, or leave it as a github draft. Please make sure it is compliant with our contributing guidelines. In particular, be sure it checks the boxes listed below.
For new features:
For bug fixes:
We will review it as quick as possible, feel free to ping us with questions if needed. |
Codecov Report
@@ Coverage Diff @@
## main #3990 +/- ##
========================================
Coverage 91.76% 91.76%
========================================
Files 134 134
Lines 15781 15781
Branches 3289 3114 -175
========================================
Hits 14482 14482
Misses 755 755
Partials 544 544
Flags with carried forward coverage won't be shown. Click here to find out more. 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me.
At some point we are going to need a diagram how the CI for the doc works. I am still not as good as you are juggling with it.
This PR is a bit cryptic to me. Any way to check that it works OK ? |
Yes happy to discuss it and explain why we do it this way. We can also think about how to document it better for devs |
Can we use mermaid, pretty please?! flowchart LR
build-docs.yml --> build_type.sh
😃 |
I don't know it but sure happy to try it out! |
With the current set up, a failure on the doc build prevents circleci from hosting the docs that have been built. This is annoying since the htmls exist but cannot be easily viewed (sometimes for very trivial errors) and thus hinders the review process. This PR changes the configuration so that the docs are always hosted if a build exists. Note that deploy will still only run on main only with a successful doc build.
I've tested this on my fork on main and in a PR