Repository navigation
release: v7.0.0 - #2110
Merged
Merged
release: v7.0.0#2110
Conversation
I documented the CommonMarker compatibility changes, RDoc 8 support, and reStructuredText anchor fixes since v6.0.0. I updated the package version without changing locked dependencies. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 6fe372b1-3ff6-4129-9d33-be564fb6a5f0 Signed-off-by: Zack Koppert <zkoppert@github.com>
There was a problem hiding this comment.
🟢 Approval recommended
Version metadata is consistent, and publication remains a separate action gated on application acceptance.
1 open finding
What changed in this PR
Prepares github-markup 7.0.0 to mark the compatibility boundary for existing renderer changes without publishing the gem.
Changes:
- Synchronizes source and lockfile versions.
- Adds release notes covering compatibility changes, rendering fixes, and development updates.
| File | Description |
|---|---|
lib/github-markup.rb |
Sets the package version to 7.0.0. |
HISTORY.md |
Adds compatibility guidance and release notes. |
Gemfile.lock |
Updates the local package version without changing dependencies. |
🧠 Review effort: Max
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
I documented that NOBREAKS now preserves soft line breaks and that the last supplied HARDBREAKS or NOBREAKS flag takes precedence. I verified the old renderer source and reproduced both behaviors before updating the release notes. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 6fe372b1-3ff6-4129-9d33-be564fb6a5f0 Signed-off-by: Zack Koppert <zkoppert@github.com>
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.
Why
Version
6.0.0didn't include the newer Markdown, RDoc, and reStructuredText changes, including an incompatible CommonMarker API upgrade.I prepared
7.0.0so consumers can identify the compatibility boundary before upgrading. The number of affected downstream applications is unknown.What changed
I updated
GitHub::Markup::VERSION, the lockfile's local package version, and the release history. I kept renderer implementations and locked dependency versions unchanged.The release notes cover the CommonMarker 2.x requirement, four legacy options accepted without effect, RDoc 8 support, and reStructuredText anchor fixes.
6.0.07.0.06.0.03.33.3, unchangedmasterversionsI chose a major version rather than a patch or minor release because the CommonMarker adapter requires the 2.x API. Existing installations pinned to commonmarker 0.x must upgrade to 2.x.
Testing
I ran the full 62-test suite in a fresh Codespace with RDoc 7.2 and RDoc 8.1. Both runs passed.
I built the gem and installed it outside the source checkout. I verified version
7.0.0, the Ruby requirement, runtime dependencies, and packaged Markdown, RDoc, and reStructuredText rendering.I approved publication using the completed automated and package checks, waiving the contributor guide's application/browser acceptance check. I didn't run that application-level check.
Rollout
I published version
7.0.0on RubyGems and the GitHub Release.I verified that the published gem's SHA-256 matches the built artifact and that
v7.0.0points to the merged release commit.The merged-master CI checks passed. I verified the published version and its
rdoc < 9runtime dependency on RubyGems.