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
This is a common mistake that the example seems to have encouraged, I've seen this mistake a lot in change logs trying to adhere to the (admittedly loose) keep a changelog standard. 😞
The reason will be displayed to describe this comment to others. Learn more.
Good catch! This seems super annoying to update by hand, though. Is there a tool that can lint the changelog? Do you think it's worth following this format?
The reason will be displayed to describe this comment to others. Learn more.
If you're interested, I'm considering writing a remark plugin for linting Keep A Changelog and automatically inserting links. Will then include that plugin in hallmark, which is like standard for markdown. Then you'll be able to hallmark CHANGELOG.md to lint and hallmark --fix CHANGELOG.md to insert links.
The reason will be displayed to describe this comment to others. Learn more.
@vweevers I'm definitely interested! have been wanting to automate this for a long time but never got around to it. I think remark is the right way to go too 👍
a7762a2
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The brackets in keepachangelog's format are link references.
If you look at the bottom of the example at https://keepachangelog.com/en/1.0.0/, you'll notice this section
This is a common mistake that the example seems to have encouraged, I've seen this mistake a lot in change logs trying to adhere to the (admittedly loose) keep a changelog standard. 😞
a7762a2
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch! This seems super annoying to update by hand, though. Is there a tool that can lint the changelog? Do you think it's worth following this format?
a7762a2
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
a7762a2
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cool, will do that :)
a7762a2
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you're interested, I'm considering writing a
remark
plugin for linting Keep A Changelog and automatically inserting links. Will then include that plugin inhallmark
, which is likestandard
for markdown. Then you'll be able tohallmark CHANGELOG.md
to lint andhallmark --fix CHANGELOG.md
to insert links.a7762a2
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@vweevers I'm definitely interested! have been wanting to automate this for a long time but never got around to it. I think remark is the right way to go too 👍
a7762a2
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@vweevers This is neat. Once you implement that, it would be cool to try adopting
hallmark
onstandard
a7762a2
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See https://github.com/vweevers/remark-changelog and vweevers/hallmark#37.
To try it out:
Already finds 199 issues, 73 of which can be fixed automatically. Some rules may be too strict, shall I open a PR to
standard
to discuss those?a7762a2
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@vweevers I like it! I just opened a PR with the autofix changes, which are all great! #1398