[objc docs] Fix doc generation workflow - #32550
Merged
Merged
Conversation
Use Bundler to constrain Jazzy's Mustache dependency and execute Jazzy with the resolved bundle. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Explain how to install and run the documentation generation dependencies using the docs Gemfile and Bundler. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The dependency workaround matches the linked upstream issue and is consistently applied in CI and documentation.
Pull request overview
Fixes Objective-C API documentation generation by managing Jazzy dependencies with Bundler.
Changes:
- Pins Jazzy 0.15.4 and excludes broken Mustache 1.1.3.
- Updates the workflow and local documentation to use Bundler.
- No actionable issues found.
File summaries
| File | Description |
|---|---|
objectivec/docs/Gemfile |
Defines compatible documentation dependencies. |
objectivec/docs/readme.md |
Documents Bundler-based generation. |
.github/workflows/publish-objectivec-apidocs.yml |
Installs and runs Jazzy through Bundler. |
Review details
- Files reviewed: 3/3 changed files
- Comments generated: 0
- Review effort level: Balanced
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Contributor
Author
eserscor
approved these changes
Sep 17, 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.
Description
mustacheversion to work around issue jazzy 0.15.4 fails at startup with mustache 1.1.3:undefined method 'map' for an instance of Pathnamerealm/jazzy#1435jazzyversion to latest.Motivation and Context
Fix doc generation workflow.