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

link version headers like Keep a Changelog #8

Open
brettcannon opened this issue Sep 21, 2020 · 3 comments
Open

link version headers like Keep a Changelog #8

brettcannon opened this issue Sep 21, 2020 · 3 comments
Labels
enhancement New feature or request

Comments

@brettcannon
Copy link

https://keepachangelog.com/ has a neat thing where the version number gets linked to a diff view between versions.

@nedbat
Copy link
Owner

nedbat commented Sep 21, 2020

Huh, I had seen the version number in square brackets, and hadn't put it together that it was Markdown reference-style link. I think I've seen changelogs that used the brackets, but didn't make them links, but I can't find any now...

Yes, this is a cool feature. I think I would make the link more explicit, but it's a good idea.

@brettcannon
Copy link
Author

Yeah, I totally overlooked it initially as well, thinking it was a style thing. 😄

@nedbat nedbat added the enhancement New feature or request label Oct 2, 2020
@DonalChilde
Copy link

DonalChilde commented May 30, 2023

I also like that format, and I was able to get it using a custom entry_title_template:

{% if version %}[{{ version }}](https://github.com/_user_/_project_/compare/_previous_version_tag_...{{version}}) — {% endif %} {{ date.strftime('%Y-%m-%d') }}
{{"\n"}}
Whats Changed in {{version}}

where user and project are handled in my cookiecutter project setup, and I manually correct the previous version tag for each scriv collect.

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

3 participants