Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
zavan opened this issue Mar 2, 2017 · 8 comments
Closed

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

zavan opened this issue Mar 2, 2017 · 8 comments
Assignees
Milestone

Comments

@zavan
Copy link

zavan commented Mar 2, 2017

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)

@cllns
Copy link
Member

cllns commented Mar 10, 2017

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

vs Hanami's release page:
image

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: olivierlacan/keep-a-changelog#1

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

What do you think @zavan (and others)?

@jodosha
Copy link
Member

jodosha commented Mar 12, 2017

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

@zavan
Copy link
Author

zavan commented Mar 13, 2017

@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
Copy link
Member

jodosha commented Mar 13, 2017

@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
Copy link
Contributor

We can try that for the next version.

@jodosha jodosha added this to the v1.1.0 milestone Apr 25, 2017
@jodosha
Copy link
Member

jodosha commented Apr 25, 2017

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

Closing this issue as "fixed".

@jodosha jodosha closed this as completed Apr 25, 2017
@cllns
Copy link
Member

cllns commented Apr 25, 2017

@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
Copy link
Contributor

@cllns thanks for the comment ;)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants