search

thoughtbot / guides

A guide for programming in style.
https://thoughtbot.com/playbook
9.47k stars 1.37k forks source link

Something different than `rake release`? #208

Closed croaky closed 9 years ago

croaky commented 10 years ago

Our open source protocol currently says to release using rake release:

https://github.com/thoughtbot/guides/tree/master/protocol/open-source

If I'm understanding things correctly, this results in a git tag, but not a GitHub release, being created like this:

https://github.com/thoughtbot/suspenders/releases/tag/v1.15.0

I think there needs to be a step after rake release where we write a nice message at https://github.com/thoughtbot/suspenders/releases/new?tag=v1.15.0 so it looks more like the nice one @mjankowski wrote at https://github.com/thoughtbot/suspenders/releases/tag/v1.14.0. Is that correct?

mcmire commented 10 years ago

Do we use GitHub releases consistently across our projects, though? It seems that for the majority of projects we still add to NEWS (or CHANGELOG, or whatever the equivalent is).

I guess that's the question you're asking?

gabebw commented 10 years ago

I think Griddler uses GitHub releases. I don't think it's common, though.

mcmire commented 10 years ago

@plapier Don't you use releases for Bourbon? What has your experience been with this?

guilhermesimoes commented 10 years ago

Given we as a community have managed to standardize README.md and CONTRIBUTE.md, I would like to advocate the use of CHANGELOG.md.

Just last month Olivier Lacan ranted a bit at the Ruby5 podcast and he even created a little website about it.

Also, I use Gemnasium, a cool project to track dependencies, and they parse changelogs to display what has changed between versions. I don't know if thoughtbot uses Gemnasium but it would be great if you used the format.

gabebw commented 10 years ago

I'd like to clarify that Olivier Lacan's Keep a Changelog site is actually advocating a NEWS file, not a ChangeLog. A ChangeLog is simply a list of commits (like git log). A NEWS file is a curated list of changes since the last version: https://github.com/thoughtbot/griddler/blob/master/NEWS.md

That's why we at thoughtbot call it NEWS.md, not ChangeLog.md, because a ChangeLog as expected is useless - that's why we have git log.

jferris commented 10 years ago

It would be nice to have something which generated releases from the git tag. The git tag message is visible everywhere (including a local checkout), whereas git releases are a GitHub-specific feature.

mcmire commented 10 years ago

I agree. Do we want to make git tag -a part of the rake task?

sikachu commented 9 years ago

You can do git tag -a -s and then do rake release — Bundler will just warn about pre-existing tag, but does everything else like usual.

jferris commented 9 years ago

This discussion seems to have wrapped up, and there doesn't seem to be an immediate action item here. I'm going to close this, but feel free to comment if you have any further thoughts.