chore: pin the docs toolchain with a Gemfile so jazzy builds reproducibly - #523
Merged
Conversation
…ibly The build-docs action ran a bare `gem install jazzy`, so every run resolved dependencies afresh. mustache 1.1.3, published 2026-08-20, reworked `template_path=` to take a String or an Array, while jazzy passes it a Pathname. jazzy 0.15.4 allows `mustache ~> 1.1`, so runs began picking 1.1.3 up and failing with "undefined method 'map' for an instance of Pathname" while jazzy parsed its own configuration, before reading any source. A Gemfile and committed lockfile make the resolution explicit, and hold mustache below 1.1.3 until jazzy accommodates the new signature. Co-authored-by: Cursor <cursoragent@cursor.com>
abelonogov-ld
enabled auto-merge (squash)
August 21, 2026 21:13
LaunchDarkly SDK repos don't track lockfiles, and the lockfile was not what fixed the docs build: `bundle install` honors the `mustache < 1.1.3` requirement whether or not one is checked in. Drop it, ignore it so a local `bundle install` leaves a clean tree, and name jazzy's version exactly so the two gems that decide whether jazzy runs are both pinned in the Gemfile. Co-authored-by: Cursor <cursoragent@cursor.com>
tanderson-ld
approved these changes
Aug 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
build-docshas been failing on every PR since 2026-08-20 — see for example this run — with:The cause is dependency resolution, not anything in our source.
.github/actions/build-docsran a baregem install jazzywith no Gemfile or lockfile, so each run resolved afresh. mustache 1.1.3, published 2026-08-20, reworkedtemplate_path=:jazzy's
theme_directory=passes aPathname, which is neither, so.mapraises. jazzy 0.15.4 permitsmustache ~> 1.1, so runs started picking up 1.1.3. The failure happens insideJazzy::Config#parse!while jazzy reads its own configuration, before it looks at any Swift, which is why it reproduces regardless of the branch's contents. It went unnoticed because the last CI run onv11predates the mustache release.This adds a
Gemfileand a committedGemfile.lockand switches the action tobundle install/bundle exec jazzy, so the toolchain is pinned rather than re-resolved per run. mustache is held below 1.1.3 with a comment explaining why, to be relaxed once jazzy accommodates the new signature.Resolved versions:
jazzy 0.15.4,mustache 1.1.2.Test plan
bundle lockresolves to mustache 1.1.2, confirmed against the lockfiletemplate_path=accepts aPathnameand 1.1.3's does notbuild-docspasses on this PR (2m07s), and the rest of the run is greenNote
Overview
Fixes failing
build-docsCI by stopping baregem install jazzy, which could pull mustache 1.1.3 and break jazzy when it passes aPathnameintotemplate_path=.Adds a
Gemfilepinning jazzy 0.15.4 and mustache < 1.1.3 (with a short comment on the incompatibility). The build-docs composite action now runsbundle installandbundle exec jazzy -o docs..gitignoreignores/Gemfile.lock, so resolution is driven by the Gemfile constraints rather than a tracked lockfile.Reviewed by Cursor Bugbot for commit 36b1c4b. Bugbot is set up for automated code reviews on this repo. Configure here.