saz / puppet-ssh

Puppet module to manage ssh server and client
http://forge.puppetlabs.com/saz/ssh
Other
123 stars 236 forks source link

docs: use correct heading layout for changelog file #360

Closed MindTooth closed 1 year ago

MindTooth commented 1 year ago

I've tried getting a correct changelog for this project using Renovate, but it seems it's been unable to parse the CHANGELOG.md file correctly.

I think it's because the markdown is not valid and it needs to have empty lines between the headings. Look at the upstream changelog as reference: https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md

Also, the spec itself uses empty lines: https://keepachangelog.com/en/1.1.0/ - I hope that GitHub will also add links to the versions like the upstream file has. Seeing as the markdown has not []() around the tags.