You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Describe the bug
Characters like < and > are parsed as markdown syntax and won't shown in output.
Something like feat: add <Header> to <App> will shown as: feat: add to
Current behavior
Characters like < and > are parsed as markdown syntax.
Expected behavior
Escape markdown syntax from commit messages.
Environment
commit-and-tag-version version(s): 12.1.0
Node/npm version: v20.3.1
The text was updated successfully, but these errors were encountered:
Yea, the generated changelog is correct. But the < & > characters will be parsed and won't shown in the output.
Also, I agree that having markdown syntax in the commit message is helpful, But I think it will be awesome if we can have an option to parse or escape it.
Am I right in understanding that the issue is that they're parsed by markdown, because they weren't escaped at the time the markdown file is written?
I think escaping the characters that markdown interprets would be a bit unexpected, so this doesn't feel like a bug to me. But, I see how it might be useful to be able to do this with a config option.
This project is intended to be a wrapper around conventional-changelog. Conventional-changelog controls the writing of the changelog, and I think the package that knows how to write markdown is conventional-changelog-writer (although I'm not certain). You might want to open an issue / PR over there.
Describe the bug
Characters like < and > are parsed as markdown syntax and won't shown in output.
Something like
feat: add <Header> to <App>
will shown as:feat: add to
Current behavior
Characters like < and > are parsed as markdown syntax.
Expected behavior
Escape markdown syntax from commit messages.
Environment
commit-and-tag-version
version(s): 12.1.0The text was updated successfully, but these errors were encountered: