Hanami: Publish release notes for services like sibbell.com?

[zavan]

Sibbel is a service that notifies devs about package updates:

It shows release notes in the email and website:

But not when they're not filled :(

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

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

[cllns]

I think a more pressing reason would be including the notes on the Releases page, rather than this specific tool. For example:

vs Hanami's release page:

It looks like the way to do this is through GitHub's UI: https://github.com/blog/1547-release-your-software and the notes aren't stored within Git itself, but on GitHub.

hanami* Releases are done with bundle exec rake release. It looks like GitHub release notes are not supported. We'd have to implement this ourselves, plus complicate the release process, by dealing with GitHub API tokens.

Some relevant discussion: https://github.com/olivierlacan/keep-a-changelog/issues/1

Seems like a lot of work for a minor nice-to-have feature :/

What do you think @zavan (and others)?

[jodosha]

@zavan Hey, thanks for your suggestion. How does Sibbel work? By manual entry from us?

[zavan]

@jodosha It fetches your GitHub faved repos and sends you an email when there's a new release/tag, in the email it sends the changes if they're on the GitHub release. Refer to @cllns for how to publish the changes.

@cllns I agree that integrating this in the release process is too much work for a "nice to have", I'd just CTRL+C/CTRL+V the markdown from the CHANGELOG into the GitHub release, since they're not THAT frequent after all.

[jodosha]

@zavan Gotcha. Thank you.

I agree that integrating this in the release process is too much work for a "nice to have", I'd just CTRL+C/CTRL+V the markdown from the CHANGELOG

This can work.

[AlfonsoUceda]

We can try that for the next version.

[jodosha]

Okay, let's give it a shot. @AlfonsoUceda please take care of this.

Closing this issue as "fixed".

[cllns]

@AlfonsoUceda This is the page you need to add release notes: https://github.com/hanami/hanami/tags (have to switch to the 'Tags' tab, 'Releases' doesn't show any options for editing the release notes)

[AlfonsoUceda]

@cllns thanks for the comment ;)