Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

markdown special symbols in commit description should be escaped #47

Closed
ChALkeR opened this issue May 1, 2017 · 3 comments
Closed

markdown special symbols in commit description should be escaped #47

ChALkeR opened this issue May 1, 2017 · 3 comments

Comments

@ChALkeR
Copy link
Member

ChALkeR commented May 1, 2017

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).

@ChALkeR ChALkeR changed the title changelog-maker should escape markdown special symbols in commit description markdown special symbols in commit description should be escaped May 1, 2017
@wooorm
Copy link

wooorm commented May 1, 2017

Hi folks! 👋

Shameless plug, but maybe remark can help here, as it automatically deals with escapes and stuff! Here’s an example of how it could look, where a readme is generated from a package.json in a monorepo.

Let me know if that’s of interest!

@MylesBorins
Copy link
Contributor

BUMP to this

This actually broke CI today as it broke the markdown linter

nodejs/node#18767

rvagg added a commit that referenced this issue Mar 1, 2018
@rvagg
Copy link
Member

rvagg commented Mar 1, 2018

fixed in #52, pls 👍

rvagg added a commit that referenced this issue Mar 1, 2018
@rvagg rvagg closed this as completed in #52 Mar 1, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants