Skip to content

fix(docs): graceful degradation for aztec-nr API doc generation on Netlify#21919

Merged
critesjosh merged 2 commits into
nextfrom
josh/fix-netlify-docs-graceful-degradation
Apr 16, 2026
Merged

fix(docs): graceful degradation for aztec-nr API doc generation on Netlify#21919
critesjosh merged 2 commits into
nextfrom
josh/fix-netlify-docs-graceful-degradation

Conversation

@critesjosh

Copy link
Copy Markdown
Contributor

Summary

  • Makes the Netlify preview build continue when aztec-nr API doc generation fails, instead of aborting the entire deploy
  • Fixes the issue seen in chore: Remove Noir builtin comptime mutable methods from macros #21801 where the preview deploy fails because the downloaded nargo nightly binary lacks new comptime APIs (FunctionDefinition::disable, TypeDefinition::add_abi) that the aztec-nr code uses

Context

The Netlify preview build downloads a pre-built nargo binary via noirup. When the noir submodule in aztec-packages is ahead of the latest published nightly, nargo doc can fail because the binary doesn't have APIs that aztec-nr's macros depend on. This blocks the entire preview deploy even though the API docs are non-essential for PR review.

With this change, the build logs a warning and continues without API docs rather than failing entirely.

Test plan

  • Verify Netlify preview deploys successfully even when nargo version is incompatible
  • Verify API docs still generate normally when nargo version is compatible

…s on Netlify

The Netlify preview build downloads a pre-built nargo nightly binary via
noirup. When the noir submodule is ahead of the latest published nightly,
nargo may lack new comptime APIs used by aztec-nr, causing doc generation
to fail and blocking the entire preview deploy.

This makes the build continue without API docs rather than aborting,
so PR previews still deploy even when nargo is temporarily out of sync.
@critesjosh critesjosh marked this pull request as ready for review March 23, 2026 21:07
@critesjosh critesjosh requested a review from a team March 23, 2026 21:07
@critesjosh critesjosh added this pull request to the merge queue Apr 16, 2026
Merged via the queue into next with commit 940381a Apr 16, 2026
18 of 19 checks passed
@critesjosh critesjosh deleted the josh/fix-netlify-docs-graceful-degradation branch April 16, 2026 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants