Add nightly CI for documentation builds #231
Conversation
|
I think this looks good. What the difference is between the two versions? |
|
any idea why CI are all failing here? |
You can now run, e.g. `EXECUTE_NOTEBOOKS="false" just doc --dirty`
david-pl
force-pushed
the
david/228-docs-ci
branch
from
ad5e874 to
76fd749
Compare
|
One builds the documentation with the release versions. This is to catch accidental breaking changes in patch versions (to which bloqade is not pinned) in the
I updated the examples to a bloqade-circuit version that wasn't available the first time around, I think. |
I think these would serve good explainations maybe we can have them as a comment inside these two GitHub action files? otherwise LGTM. |
|
Good point, I'll add comments. There's still the printing issue with the multiple line breaks though. Not sure what causes it, I'll have to look into it. Of course, we could also skip the execution for now, but that makes the CI here kind of useless. |
|
We can always get rid of rich in the worst case. Rich is doing too much here perhaps. |
|
I tried again to debug this, but I just can't seem to figure it out. I tried every kwarg to Also, it's not just |
|
maybe we can merge the action first? Then we can discuss how to fix it separately. I feel the bug is probably not in rich but in mkdocs plugin. |
But this will deploy the docs with the broken printing. Related question, though: should this action actually deploy the docs? We still have the CI for release deployments. |
|
ok I'm serious considering to just do the printing myself instead of rich now. See also QuEraComputing/kirin#415 |
Closes #228 and possibly also #219
Needs a release of bloqade-circuit v0.2.0 first as it also updates the examples to work with the new version.
Also, I'm checking the versions / commit hashes for the nightly builds and cancel the jobs if nothing has changed. To do this, I'm using github variables. Not sure if this is the best solution. If it is, then we'd need to create the variables (the body can be empty to start with). There are probably permission issues then as well since I don't think the
GH_TOKENhas permissions to set github variables and cancel jobs.@Roger-luo @weinbe58 do you know a better solution for this?