search

zestsoftware / zest.releaser

Python software releasing made easy and repeatable
https://zestreleaser.readthedocs.io
GNU General Public License v2.0
198 stars 62 forks source link

Added key update_history in data. #280

Closed mauritsvanrees closed 6 years ago

mauritsvanrees commented 6 years ago

This replaces PR #279.

This is in prerelease and postrelease data. Plugins can use this to tell zest.releaser (and other plugins) to not touch the history, presumably because the plugin itself handles it.

Default value is True: do update history.

The update_history key will be used by a towncrier plugin that will update the changelog with news fragments.

The towncrier plugin will add an internal data key _towncrier_applicable. With this, you would get this warning when running zest.releaser:

Internal detail: key(s) ['_towncrier_applicable'] are not documented

So I have changed this internal check to allow undocumented data keys when they start with underscore.

mauritsvanrees commented 6 years ago

I have create a plugin here: https://github.com/collective/zestreleaser.towncrier

mauritsvanrees commented 6 years ago

@reinout Can you have a look at this?

reinout commented 6 years ago

I shouldn't move jobs... that's bad for my review queue :-)

reinout commented 6 years ago

I assume you want to release it? Feel free. I'm not doing it yet as you might have other things thought out while I was to lazy to review this :-)

mauritsvanrees commented 6 years ago

Released in zest.releaser 6.15.0.