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

Add comparison links in Changelog #153

Open
madmath03 opened this issue Dec 10, 2019 · 3 comments
Open

Add comparison links in Changelog #153

madmath03 opened this issue Dec 10, 2019 · 3 comments
Labels
enhancement New feature or request
Milestone

Comments

@madmath03
Copy link

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 ?

@ivanhercaz
Copy link

@madmath03, it sounds very interesting.

@jabby
Copy link

jabby commented Dec 10, 2019

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.

@frinyvonnick
Copy link
Owner

Hi @madmath03 👋

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

@frinyvonnick frinyvonnick added the enhancement New feature or request label Jan 3, 2020
@frinyvonnick frinyvonnick added this to the 2.2.0 milestone Jan 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants