search

nedbat / scriv

Changelog management tool
https://scriv.readthedocs.io
Apache License 2.0
256 stars 28 forks source link

Provide a way to get the new entry by itself #25

Closed brettcannon closed 3 years ago

brettcannon commented 3 years ago

It would be great if there was a way to just get the body of what would be written to the changelog so it could be included in e.g. a GitHub release without having to manually copy and paste it (and thus automate creating the release).

If scriv collect prints the new entry to stdout then this is a suggestion to mention that in the docs.

nedbat commented 3 years ago

I've refactored the code to create an API in #28. Does it look like it would do what you want?

brettcannon commented 3 years ago

Yep, looks great!

brettcannon commented 3 years ago

A quick thanks for the API! When I cut a release now, I am able to:

  1. Gather the release notes thanks to https://github.com/brettcannon/python-launcher/blob/main/release/notes.py
  2. Update the changelog
  3. Create a GitHub release with appropriate release notes