Bump ReverseMarkdown from 3.19.0 to 5.5.0#137
Conversation
--- updated-dependencies: - dependency-name: ReverseMarkdown dependency-version: 5.5.0 dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>
Up to standards ✅🟢 Issues
|
There was a problem hiding this comment.
Pull Request Overview
This pull request updates the ReverseMarkdown dependency from version 3.19.0 to 5.5.0. Although Codacy analysis indicates the change is 'up to standards', this update represents a significant major version leap (3.x to 5.x) which includes documented breaking API changes.
Specifically, the library underwent a major refactor to use 'TextWriter' and renamed several configuration properties (e.g., 'SuppressNewlines' to 'SuppressDivNewlines'). This PR lacks corresponding code adjustments to handle these breaking changes, which may lead to compilation failures or runtime issues. Furthermore, no tests were provided to verify that the output formatting remains consistent after the upgrade.
About this PR
- This major version jump (3.x to 5.x) contains multiple breaking API changes documented in the release notes. For example, 'SuppressNewlines' was renamed to 'SuppressDivNewlines' in version 4.3.0, and a major refactor to 'TextWriter' occurred in 5.0.0. Please ensure the implementation in 'DocsGenerator.csproj' and related files is updated to remain compatible with the new API.
- No tests were added or modified to verify that the library upgrade doesn't regress current documentation generation behavior or formatting.
Test suggestions
- Verify that existing documentation generation logic is compatible with the version 5.x API (checking for breaking changes like the SuppressNewlines rename).
- Regression test to ensure Markdown output remains consistent with the previous version for standard HTML inputs.
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Verify that existing documentation generation logic is compatible with the version 5.x API (checking for breaking changes like the SuppressNewlines rename).
2. Regression test to ensure Markdown output remains consistent with the previous version for standard HTML inputs.
TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback
|
Superseded by #138. |
Updated ReverseMarkdown from 3.19.0 to 5.5.0.
Release notes
Sourced from ReverseMarkdown's releases.
5.5.0
What's Changed
Full Changelog: mysticmind/reversemarkdown-net@5.4.0...5.5.0
5.4.0
✨ New features
🐛 Bug fixes
[[UnmanagedCallersOnly]](…)previously became[\[UnmanagedCallersOnly\]](…). Brackets inside backtick code spans are now left untouched; brackets outside code spans are still escaped.🔧 Maintenance
Full Changelog: mysticmind/reversemarkdown-net@5.3.0...5.4.0
5.3.0
What's Changed
Full Changelog: mysticmind/reversemarkdown-net@5.2.1...5.3.0
5.2.1
What's Changed
Full Changelog: mysticmind/reversemarkdown-net@5.2.0...5.2.1
5.2.0
What's Changed
<pre>content as HTML by @mysticmind in Add option to convert <pre> content as HTML mysticmind/reversemarkdown-net#422Full Changelog: mysticmind/reversemarkdown-net@5.1.0...5.2.0
5.1.0
What's Changed
New Contributors
Full Changelog: mysticmind/reversemarkdown-net@5.0.0...5.1.0
5.0.0
What's Changed
<p>Tags by @ssperling-wmp in Fixing #408 Exponential Time Complexity Bug Causing Hangs with Nested <p> Tags mysticmind/reversemarkdown-net#409Milestone 5.0.0
New Contributors
Full Changelog: mysticmind/reversemarkdown-net@4.7.0...5.0.0
4.7.1
Fix Exponential Time Complexity Bug Causing Hangs with Nested
<p>Tags GH-408 by @ssperling-wmp (cherry-picked and merged from master)Full Changelog: mysticmind/reversemarkdown-net@4.7.0...4.7.1
4.7.0
What's Changed
New Contributors
Full Changelog: mysticmind/reversemarkdown-net@4.6.0...4.7.0
4.6.0
What's Changed
New Contributors
Full Changelog: mysticmind/reversemarkdown-net@4.5.0...4.6.0
4.5.0
Full Changelog: mysticmind/reversemarkdown-net@4.4.0...4.5.0
4.4.0
Full Changelog: mysticmind/reversemarkdown-net@4.3.0...4.4.0
4.3.0
SuppressNewlinestoSuppressDivNewlines. Note that 4.2.0 was published with incorrect name so unlisted it rather than bumping up the major version due to this change.Full Changelog: mysticmind/reversemarkdown-net@4.2.0...4.3.0
4.2.0
What's Changed
Note: NuGet version unlisted due to incorrect config name, see 4.3.0 for details.
New Contributors
Full Changelog: mysticmind/reversemarkdown-net@4.1.0...4.2.0
4.1.0
Whats Changed
s,delandstrike#356Full Changelog: mysticmind/reversemarkdown-net@4.0.0...4.1.0
4.0.0
What's Changed
<sup>tag conversion by @francescolf in Add support for <sup> tag conversion mysticmind/reversemarkdown-net#358New Contributors
Full Changelog: mysticmind/reversemarkdown-net@3.25.0...4.0.0
3.25.0
Full Changelog: mysticmind/reversemarkdown-net@3.24.0...3.25.0
3.24.0
What's Changed
Full Changelog: mysticmind/reversemarkdown-net@3.23.1...3.24.0
Milestone: https://github.com/mysticmind/reversemarkdown-net/milestone/24?closed=1
3.23.1
Full Changelog: mysticmind/reversemarkdown-net@3.23.0...3.23.1
3.23.0
Full Changelog: mysticmind/reversemarkdown-net@3.22.0...3.23.0
3.22.0
Full Changelog: mysticmind/reversemarkdown-net@3.21.0...3.22.0
3.21.0
Full Changelog: mysticmind/reversemarkdown-net@3.20.0...3.21.0
3.20.0
Commits viewable in compare view.
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
@dependabot rebasewill rebase this PR@dependabot recreatewill recreate this PR, overwriting any edits that have been made to it@dependabot show <dependency name> ignore conditionswill show all of the ignore conditions of the specified dependency@dependabot ignore this major versionwill close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this minor versionwill close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this dependencywill close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)