rom-rb / rom

Data mapping and persistence toolkit for Ruby
https://rom-rb.org
MIT License
2.09k stars 161 forks source link

Publish release notes for services like sibbell.com? #385

Closed zavan closed 7 years ago

zavan commented 7 years ago

Sibbel is a service that notifies devs about package updates:

image

It shows release notes in the email and website:

image

But not when they're not filled :(

image

So it would be nice if you could include release notes with the tags.

(I'm not affiliated to sibbel in any way)

solnic commented 7 years ago

I don't know how this service works, but we do keep an up-to-date CHANGELOG all the time. So I'm not sure what we're supposed to do to make it work with sibbel. I like the idea so I'd appreciate any help with integrating.

zavan commented 7 years ago

@solnic Sibbel and other services read it from GitHub's release notes.

It's basically step 6 of this guide: https://help.github.com/articles/creating-releases/

Release

Since you already keep a CHANGELOG, you can simply copy the entry from the CHANGELOG to the GitHub release when creating the release tag (although it may not be so simple if your release process is automated).

solnic commented 7 years ago

OK I'll start including release notes in tag commit messages, this should do the trick