Skip to content

fix: work around Zig docs build failures #442

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

Merged
merged 11 commits into from
Mar 15, 2025
Merged

fix: work around Zig docs build failures #442

merged 11 commits into from
Mar 15, 2025

Conversation

aherrmann
Copy link
Owner

Zig docs builds frequently failed on CI, see #273. Two cases were observed:

  1. Zig docs builds failed when remote execution was enabled.
  2. Zig docs builds failed locally on MacOS with Zig version 0.12.0.

The first case is addressed by moving Zig docs build tests into a separate CI job and disabling remote execution in that case.
The second case is addressed by marking Zig docs targets as incompatible with Zig version 0.12.0 and MacOS systems.

This is a workaround, not a proper fix of #273.

  • Remove test.sh check from CI script
  • Tag all Zig documentation targets
  • Use tag filters to skip Zig docs builds
  • Add separate Zig docs tests
  • Exclude zig-docs in presubmit.yml
  • build_test target for runfiles docs
  • Zig docs tests for all Zig versions using transitions
  • Reduce zig-docs CI matrix
  • Disable remote execution on Zig docs tests
  • Avoid parallelism for Zig docs builds
  • Skip Zig docs on MacOS with Zig 0.12.0

No need to be overly generic.
The tests use transitions to test multiple Zig versions, so the CI
matrix is not needed on that axis. The Bazel version should not be
relevant, so the test is limited to the latest Bazel version.
That Zig version specifically is failing local builds with
```
error: unable to open directory '/var/tmp/zig-cache/b/1f12c83657f1b28979d409d11f49642c/': FileNotFound
```
@aherrmann aherrmann enabled auto-merge March 15, 2025 14:14
@aherrmann aherrmann merged commit 69b0a7f into main Mar 15, 2025
55 checks passed
@aherrmann aherrmann deleted the docs-build branch March 15, 2025 14:33
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.

1 participant