Skip to content

Declare compatible RDoc as a runtime dependency - #2104

Open
ydah wants to merge 1 commit into
github:masterfrom
ydah:fix-rdoc-runtime-dependency
Open

ydah wants to merge 1 commit into
github:masterfrom
ydah:fix-rdoc-runtime-dependency

Conversation

@ydah

@ydah ydah commented Oct 1, 2026

Copy link
Copy Markdown

require 'github/markup' unconditionally loads the RDoc renderer, but the gemspec does not declare rdoc as a runtime dependency. Loading fails with LoadError: cannot load such file -- rdoc in a runtime-only bundle on Ruby 4.0. The development bundle includes RDoc and masks the missing declaration.

Declare rdoc < 8 as a runtime dependency and update the local package entry in Gemfile.lock. RDoc 8 changes the RDoc::Markup::ToHtml constructor used by the renderer, so an unbounded dependency would fix loading but break RDoc rendering with ArgumentError.

This change targets the current 6.0.0 source. Consumers such as gollum-lib that require github-markup ~> 4.0 would need a corresponding 4.x backport and release.

Copilot AI balanced review requested due to automatic review settings October 1, 2026 05:34

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟢 Approval recommended

The dependency declaration and lockfile update are complete, consistent, and appropriately constrained for the existing renderer API.

Review effort: Balanced
Findings: None

What changed in this PR

Declares the RDoc version range required for reliable runtime loading and rendering.

Changes:

  • Adds rdoc < 8 as a runtime dependency.
  • Updates the lockfile’s local gem specification.
File Description
github-markup.gemspec Declares the compatible RDoc runtime dependency.
Gemfile.lock Records the new dependency for the local package.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

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