gitmoji-changelog icon indicating copy to clipboard operation
gitmoji-changelog copied to clipboard

Add comparison links in Changelog

Open madmath03 opened this issue 5 years ago • 3 comments

After looking at keepachangelog, I thought it might be nice to automatically generate comparison links between versions :

[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...HEAD
[1.0.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...v1.0.0
[0.3.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.2.0...v0.3.0
[0.2.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.1.0...v0.2.0
[0.1.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.8...v0.1.0
[0.0.8]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.7...v0.0.8
[0.0.7]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.6...v0.0.7
[0.0.6]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.5...v0.0.6
[0.0.5]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.4...v0.0.5
[0.0.4]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.3...v0.0.4
[0.0.3]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.2...v0.0.3
[0.0.2]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.1...v0.0.2
[0.0.1]: https://github.com/olivierlacan/keep-a-changelog/releases/tag/v0.0.1

In keepachangelog, they suggest to add all links at the end of the file, but I think it might be better to add the compare link to the previous version at the end of each version block. What do you think ?

madmath03 avatar Dec 10 '19 12:12 madmath03

@madmath03, it sounds very interesting.

ivanhercaz avatar Dec 10 '19 13:12 ivanhercaz

FYI about gitlab :

  • {url-repo}/compare/v1.0.0...master
  • {url-repo}/compare/v0.8.0...v1.0.0

It seems that HEAD does not work. I'm not sure if there is a way to determine the default branch for unreleased commits.

jabby avatar Dec 10 '19 19:12 jabby

Hi @madmath03 👋

Nice idea, we need to make a PR on hosted-git-info so it handles a compare link 😄

frinyvonnick avatar Dec 11 '19 13:12 frinyvonnick