Skip to content
This repository has been archived by the owner on May 16, 2022. It is now read-only.

[RFE] Add support for towncrier #199

Open
bowlofeggs opened this issue Mar 26, 2019 · 3 comments
Open

[RFE] Add support for towncrier #199

bowlofeggs opened this issue Mar 26, 2019 · 3 comments
Labels
feature New feature or a request for enhancement.

Comments

@bowlofeggs
Copy link

It would be nice if release-bot supported towncrier, a tool that helps you generate release notes.

@TomasTomecek
Copy link
Member

There is a PR #175 opened which utilizes gitchangelog for this. Would it make sense to support multiple changelog generation backends? And let user pick the preferred one.

@TomasTomecek TomasTomecek added the feature New feature or a request for enhancement. label Mar 27, 2019
@bowlofeggs
Copy link
Author

Good question, I'm actually not familiar enough with either project to comment about whether they fully overlap with features or not.

Do you know if gitchangelog makes it possible to show only part of a commit message as release notes, vs the entire commit message? I wouldn't want every commit message shown, and I also would want a separation between which part of the message was intended for developers, vs. intended for users.

@lachmanfrantisek
Copy link
Member

I wouldn't want every commit message shown, and I also would want a separation between which part of the message was intended for developers, vs. intended for users.

You can specify some message prefix (new/fix/..) and gitchangelog takes only those commits and groups them to the final changelog.

In their sample commits they have dev and usr as well:

* 59f902a Valentin Lab new: dev: sections in changelog are now in the order given in ``gitchangelog.rc`` in the ``section_regexps`` option.  (0.1.2)
* c6f72cc Valentin Lab chg: dev: commented code to toggle doctest mode.
* 59524e6 Valentin Lab new: usr: added ``body_split_regexp`` option to attempts to format correctly body of commit.

You can probably configure some custom matching/parsing but I've not used that.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
feature New feature or a request for enhancement.
Projects
None yet
Development

No branches or pull requests

3 participants