-
-
Notifications
You must be signed in to change notification settings - Fork 10
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
Add support for format of "Keep a Changelog" #11
Conversation
With the detection of the format of Keep a Changelog, this PR does not does not address the example of #1 anymore. I would say that this is acceptable, because it should be easy to convert that concrete example to a format close to "Keep a Changelog".
The spurious markdown link is because the linked HISTORY.md does not put all links to versions to the end of the file. Further, the linked file does not follow the convention to put links to issues es "embedded links" and not the end of the file. |
I use Do you think your change won't break anything? |
Should not break nothing for me. But what about some others that might have links?
|
OK, I included a check for the format of "KeepAChangelog" ( As a consequence, second-level headings are only regarded if the format is approximately the format of "KeepAChangelog". The edge cases where users use I also added |
I successfully released version 1.1.1 of MADR using this patch on Windows 10. So the PR is finally 😇 good to go from my side! |
LGTM, thanks for this work! |
Keep a Changelog is an initiative for consistent CHANGELOG.md formatting. It especially includes links to GitHub diffs.
Example Changelog: https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md
This PR adds support for that format.