Add yarn build check to CI for the docs
#1952
Comments
|
That was a plan, currently not the case |
iAmMichaelConnor
pushed a commit
that referenced
this issue
Sep 3, 2023
fixes: #1952 fixes: #1908 # Overview Makes docs rebuild on every pr, the reason for this being that the pre processor can reference ANY code. And we were not explicitly checking that docs builds succeeded on prs. It only takes 4 minutes to run, and runs in isolation, so its not too bad to run each time. ## TODO The docs were broken by some broken links that I have not expressly fixed, but they can be forked from this and fixed
AztecBot
pushed a commit
to AztecProtocol/docs
that referenced
this issue
Sep 3, 2023
fixes: AztecProtocol/aztec-packages#1952 fixes: AztecProtocol/aztec-packages#1908 # Overview Makes docs rebuild on every pr, the reason for this being that the pre processor can reference ANY code. And we were not explicitly checking that docs builds succeeded on prs. It only takes 4 minutes to run, and runs in isolation, so its not too bad to run each time. ## TODO The docs were broken by some broken links that I have not expressly fixed, but they can be forked from this and fixed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
We are not currently checking that updates to the docs dir are not breaking the build. If someone merges a breaking change, the dev docs site (https://aztec-docs-dev.netlify.app/) will not update.
Netlify has an integration that will notify of breaking builds, but it doesn't integrate nicely with a monorepo and would run against every single PR, not just updates to the docs, which would add unnecessary overhead. It's probably better for us to add this to our CI and only run against updates to the docs.
IIRC, @ludamad mentioned that branches prefixed with
docswill run their own CI, but not sure if this is the case.The text was updated successfully, but these errors were encountered: