Skip to content

markdown special symbols in commit description should be escaped #47

Closed
@ChALkeR

Description

The commit messages are initially in text, so rendering them as Markdown can cause errors.

To reproduce, in node, do:

$ changelog-maker --start-ref=9eddaebb --end-ref=9eddaebb
* [[`9eddaebb79`](https://github.com/nodejs/node/commit/9eddaebb79)] - **assert**: remove unnecessary use of __proto__ (Nathan Rajlich) 

If a changelog includes __proto__, we don't want it to render as «proto», we want to render it as «__proto__» or «__proto__». Without knowing more if that is code block or not, it would make sense to just escape some symbols like `_*~\, prefixing those with \.

Refs: nodejs/node#a58b48bc3bc, nodejs/node#7637, nodejs/node#12756 (comment).

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions