Permalink
Browse files

Add releasing documentation

Closes #250
  • Loading branch information...
1 parent 95c43f4 commit 9aab4c018b0afca87219bdce520dddf0a95fb295 @tysongach tysongach committed Aug 4, 2016
Showing with 29 additions and 0 deletions.
  1. +29 −0 RELEASING.md
View
@@ -0,0 +1,29 @@
+# Releasing
+
+1. Update the version number in these places:
+ - `lib/bitters/version.rb`
+ - `core/_base.scss`
+ - `package.json`
+
+1. Update `CHANGELOG.md`. We follow the guidelines from [Keep a CHANGELOG].
+
+1. Commit changes. Use the convention “Bitters vX.X.X” in your commit message.
+ There shouldn’t be code changes, and thus CI doesn’t need to run.
+
+1. Run `bundle exec rake release`, which tags the release, pushes the tag to
+ GitHub, and pushes the gem to RubyGems.org.
+
+1. Draft a [new GitHub release][github-release]. Upon publishing, a tweet will
+ _automatically be sent_ on the [@bourbonsass] Twitter account via [Zapier].
+ It will look like this:
+
+ > We’ve released Bitters {release_title}: {release_link}
+
+1. If needed, update the [contributing page] and [website example page].
+
+[Keep a CHANGELOG]: http://keepachangelog.com
+[github-release]: https://github.com/thoughtbot/bitters/releases/new
+[@bourbonsass]: https://twitter.com/bourbonsass
+[Zapier]: https://zapier.com
+[contributing page]: https://github.com/thoughtbot/bitters/blob/master/contrib/index.html
+[website example page]: https://github.com/thoughtbot/bitters/blob/gh-pages/example.html

0 comments on commit 9aab4c0

Please sign in to comment.