chore(deps): bump commonmarker from v0.18.3 to v2.8.2#2059
Merged
Conversation
dependabot
Bot
added
dependencies
Member
|
@dependabot rebase |
dependabot
Bot
force-pushed
the
dependabot/bundler/commonmarker-v2.8.2
branch
3 times, most recently
from
f3950f9 to
655213a
Compare
suacasataqui
approved these changes
May 31, 2026
This comment was marked as spam.
This comment was marked as spam.
dependabot
Bot
force-pushed
the
dependabot/bundler/commonmarker-v2.8.2
branch
from
655213a to
acb82c6
Compare
zkoppert
added a commit
that referenced
this pull request
Jun 8, 2026
Commonmarker 2.x is a from-scratch rewrite that swaps the upstream parser
from cmark-gfm (C) to comrak (Rust). It also redesigns the Ruby API:
- Module: CommonMarker -> Commonmarker (lowercase m)
- Render entry point: CommonMarker.render_html(content, opts, exts)
-> Commonmarker.to_html(content, options: {parse:, render:, extension:})
- Symbol arrays of opts/exts -> nested option hashes with snake_case keys
- :FOOTNOTES moved from a parse opt to an extension
- A bundled syntax highlighter plugin is enabled by default
The migration preserves the legacy public contract: callers can still pass
`commonmarker_opts:` and `commonmarker_exts:` as symbol arrays. The wrapper
translates each legacy symbol into the new nested hash structure.
Several behaviors had to be pinned explicitly to preserve cmark-gfm 0.x
output:
- hardbreaks defaults to true in 2.x; set false to match cmark.
- tagfilter, autolink, table, strikethrough, tasklist, and shortcodes
are extensions that default to on in 2.x but were strictly opt-in in
0.x; explicitly disable any the caller did not request.
- header_ids is on by default in 2.x and injects an empty anchor inside
every heading; explicitly disable it unless the caller requested it.
- The syntax_highlighter plugin is disabled (plugins: {syntax_highlighter: nil})
to keep `<pre lang>` blocks clean.
Closes #2059
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Zack Koppert <zkoppert@github.com>
zkoppert
force-pushed
the
dependabot/bundler/commonmarker-v2.8.2
branch
from
acb82c6 to
6ee7140
Compare
There was a problem hiding this comment.
Pull request overview
Updates the Markdown rendering dependency from the legacy commonmarker 0.x (cmark-gfm) API to commonmarker 2.x (comrak-backed), adjusting the renderer wrapper to preserve the existing option/extension contract while moving to the published Rubygems release.
Changes:
- Bump
commonmarkerfromv0.18.3(git tag) to~> 2.8.2(Rubygems) and refreshGemfile.lock. - Rewrite the
commonmarkerrenderer adapter to translate legacycommonmarker_opts/commonmarker_extsinto the 2.xCommonmarker.to_htmloptions/pluginsstructure. - Explicitly disable 2.x default-enabled extensions/plugins (e.g., syntax highlighter, header IDs, several extensions) unless callers request them, to better match 0.x behavior.
Show a summary per file
| File | Description |
|---|---|
| lib/github/markup/markdown.rb | Adapts legacy CommonMarker 0.x options/extensions to Commonmarker 2.x to_html API while attempting to preserve prior defaults. |
| Gemfile | Switches commonmarker dependency from a git tag to the released ~> 2.8.2 gem. |
| Gemfile.lock | Updates locked dependencies for the new commonmarker and its transitive deps/platform variants. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/3 changed files
- Comments generated: 0
Commonmarker 2.x is a from-scratch rewrite that swaps the upstream parser
from cmark-gfm (C) to comrak (Rust). It also redesigns the Ruby API:
- Module: CommonMarker -> Commonmarker (lowercase m)
- Render entry point: CommonMarker.render_html(content, opts, exts)
-> Commonmarker.to_html(content, options: {parse:, render:, extension:})
- Symbol arrays of opts/exts -> nested option hashes with snake_case keys
- :FOOTNOTES moved from a parse opt to an extension
- A bundled syntax highlighter plugin is enabled by default
The migration preserves the legacy public contract: callers can still pass
`commonmarker_opts:` and `commonmarker_exts:` as symbol arrays. The wrapper
translates each legacy symbol into the new nested hash structure.
Several behaviors had to be pinned explicitly to preserve cmark-gfm 0.x
output:
- hardbreaks defaults to true in 2.x; set false to match cmark.
- tagfilter, autolink, table, strikethrough, tasklist, and shortcodes
are extensions that default to on in 2.x but were strictly opt-in in
0.x; explicitly disable any the caller did not request.
- header_ids is on by default in 2.x and injects an empty anchor inside
every heading; explicitly disable it unless the caller requested it.
- The syntax_highlighter plugin is disabled (plugins: {syntax_highlighter: nil})
to keep `<pre lang>` blocks clean.
Closes #2059
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Zack Koppert <zkoppert@github.com>
zkoppert
force-pushed
the
dependabot/bundler/commonmarker-v2.8.2
branch
from
6ee7140 to
b41ed92
Compare
PR #2072 enforces a 100% line+branch coverage floor. The commonmarker 2.x migration adds a legacy options shim (lib/github/markup/markdown.rb lines 30-69) that translates the cmark-gfm 0.x :SOURCEPOS / :HARDBREAKS / etc. symbols into commonmarker 2.x parse/render/extension option hashes; none of the new branches were exercised by the existing suite. Each new test stubs the Commonmarker constant via the existing with_stub_const helper, invokes the MARKDOWN_GEMS["commonmarker"] proc with a single legacy option (or extension), and asserts the expected key/value lands in the captured options. This covers every when-branch in the two case statements plus the unknown-option / unknown-extension ArgumentError paths. After this change: 62 runs, 136 assertions, 0 failures. Line Coverage: 100.0% (226 / 226). Branch Coverage: 100.0% (55 / 55). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: Zack Koppert <zkoppert@github.com>
zkoppert
approved these changes
Jun 8, 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.
Bumps commonmarker from v0.18.3 to v2.8.2.
Release notes
Sourced from commonmarker's releases.
Changelog
Sourced from commonmarker's changelog.
... (truncated)
Commits
958a139Merge pull request #462 from gjtorikian/release/v2.8.254acd71[skip test] update changelog0898c4cMerge pull request #461 from gjtorikian/bump-version-for-alert6df2bacrelease for 2.8.2d96a850Merge pull request #460 from fukayatsu/add-alert-type-getterd935437Add alert_type accessors for alert nodes98eda97Merge pull request #459 from gjtorikian/dependabot/cargo/rb-sys-0.9.12769a13deBump rb-sys from 0.9.126 to 0.9.12731016cfMerge pull request #457 from gjtorikian/release/v2.8.18087370[skip test] update changelog