Skip to content

fix: keep hoogle image haddock from hanging in CI - #5474

Merged
blackheaven merged 3 commits into
developfrom
hoogle-haddock-hang-fix
Aug 25, 2026
Merged

fix: keep hoogle image haddock from hanging in CI#5474
blackheaven merged 3 commits into
developfrom
hoogle-haddock-hang-fix

Conversation

@blackheaven

@blackheaven blackheaven commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

Problem

The upload-hoogle-nix Concourse job regularly hangs: ~20 min of real build work, then silence until the 1h10m task ...

  • Every derivation completes except galley's haddock: last output is `galley> Warning: … could not find link dest...
  • Cachix exonerated: brig-doc narinfo from the failing run is 200, galley-doc 404 (never finished, never pushed).
  • Self-sustaining loop: the docker-image job builds imagesNoDocs (enableDocs = false), so this job is the only CI...
  • Hang site: the single haddock invocation (--hoogle --quickjump --hyperlink-source -j4) in final render. No local ...

Change

nix/wire-server.nix: new hoogleHaddockOverrides applied via .extend to the hoogle package set only:

  • doHaddockQuickjump = false — quickjump index unused by hoogle server --local
  • disableParallelBuilding — serial haddock (parallel -j$NIX_BUILD_CORES is the prime deadlock suspect; also seria...
    Scoped to the hoogle image only; production images (imagesNoDocs) and dev docs (haskellPackages) keep full haddoc...

Verification

  • nix build -L --fallback .#wireServer.hoogleImage: exit 0 in 24m36s (CI budget ≤ 50m), hyperlinked source intact, incl. `building hoogle ...
  • galley> Documentation created: …galley.txt, galley> haddockPhase completed in 1m12s
  • Hoogle DB intact without quickjump: galley.txt still contains 36 Galley.API.Teams entries
  • nix flake check: fails identically on clean develop (packages.x86_64-linux.pkgs is not a derivation) — pre-ex...

@blackheaven
blackheaven requested a review from a team as a code owner August 24, 2026 16:23
@zebot zebot added the ok-to-test Approved for running tests in CI, overrides not-ok-to-test if both labels exist label Aug 24, 2026
galley's haddock has hung indefinitely in the upload-hoogle-nix CI job
right before 'Documentation created', timing the task out after 1h10m.
The hoogle job is the only CI producer of -doc outputs, so the failure
loop is self-sustaining whenever galley changes.

Scope haddock for the hoogle image set only: disable the quickjump
index (unused for hoogle search) and render serially (parallel haddock
-j$NIX_BUILD_CORES is the prime deadlock suspect).  Production images
(imagesNoDocs, enableDocs = false) and dev docs are unaffected.

Verified locally: hoogleImage builds in 24m36s (CI budget 50m) with
hyperlinked source intact, galley haddockPhase 1m12s, hoogle DB intact.
@blackheaven
blackheaven force-pushed the hoogle-haddock-hang-fix branch from e32cd7a to 305790f Compare August 25, 2026 14:00
@blackheaven
blackheaven merged commit 10c32cc into develop Aug 25, 2026
9 checks passed
@blackheaven
blackheaven deleted the hoogle-haddock-hang-fix branch August 25, 2026 17:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ok-to-test Approved for running tests in CI, overrides not-ok-to-test if both labels exist

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants