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.

Sign up for GitHub

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

Jump to bottom

Get CI to build the docs and throw errors #1908

Closed
iAmMichaelConnor opened this issue Aug 31, 2023 · 0 comments · Fixed by #1955
Closed

Get CI to build the docs and throw errors #1908

iAmMichaelConnor opened this issue Aug 31, 2023 · 0 comments · Fixed by #1955
Labels
A-devops Area: Devops. E.g. CI / build systems

Comments

@iAmMichaelConnor
Copy link
Contributor

Currently, CI doesn't catch errors in the docusaurus build of the docs. We should start catching those, because it's tripped us up a few times.

There was a netlify bot that tried to build the docs, but we disabled it because it cluttered up all PRs.
@iAmMichaelConnor iAmMichaelConnor added the A-devops Area: Devops. E.g. CI / build systems label Aug 31, 2023
@github-project-automation github-project-automation bot moved this to Todo in A3 Aug 31, 2023
@Maddiaa0 Maddiaa0 mentioned this issue Sep 3, 2023
Merged
iAmMichaelConnor pushed a commit that referenced this issue Sep 3, 2023
@Maddiaa0
chore(ci): build docs on every pr (#1955)
c200bc5 
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
@github-project-automation github-project-automation bot moved this from Todo to Done in A3 Sep 3, 2023
AztecBot pushed a commit to AztecProtocol/docs that referenced this issue Sep 3, 2023
@Maddiaa0 @AztecBot
chore(ci): build docs on every pr (#1955)
978092d 
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
Assignees
No one assigned
Labels
A-devops Area: Devops. E.g. CI / build systems
Projects
A3
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore(ci): build docs on every pr AztecProtocol/aztec-packages
1 participant
@iAmMichaelConnor