search

mattbrictson / chandler

[unmaintained] chandler syncs your CHANGELOG entries to GitHub's release notes
MIT License
152 stars 15 forks source link

customizable release title #24

Open glensc opened 7 years ago

glensc commented 7 years ago

currently the github "tag title" is filled with just "version"

however, i used to fill there also release date:

https://github.com/eventum/scm/releases/tag/v3.1.2 2016-09-06, Version 3.1.2

now chandler will overwrite that with 3.1.2 once ran

perhaps set the tag title as the line present in changelog file itself:

2016-09-06, Version [3.1.2]

but care should be taken with the []-s (stripped because the link itself is not included): #27

mattbrictson commented 7 years ago

Thanks, I appreciate the feature suggestion. I agree that it is unfortunate that Chandler overwrites existing releases without warning; I've created a separate issue for that: #28.

In terms of the actual titles, I am happy with the current behavior, which is to use the version number only. This matches the style of projects I maintain and use. However I understand that this is not a universal practice, as I see there are some popular GitHub repositories that follow different conventions.

I'll leave this issue open for consideration in case I have time to revisit Chandler's design in the future.

glensc commented 7 years ago

well, http://keepachangelog.com/ is what where such format comes from, and i like it so that's why i use it.

mattbrictson commented 5 years ago

⚠️ This project is no longer actively maintained. I have found myself embracing tools like release-drafter to keep release notes updated automatically, rather than relying on a manually edited CHANGELOG.md. If you are interested in taking over chandler development, let me know by opening an issue.