Skip to content
Permalink
Browse files

Update releasing documentation

  • Loading branch information...
tysongach committed Oct 8, 2019
1 parent 6ce9f78 commit b74dd24063701e82ac47504757832d8836e9acc1
Showing with 7 additions and 8 deletions.
  1. +7 −8 RELEASING.md
@@ -6,25 +6,24 @@
- `core/_base.scss`
- `package.json`

1. Update `CHANGELOG.md`. We follow the guidelines from [Keep a CHANGELOG].
1. Update `CHANGELOG.md`. We follow the guidelines from
[Keep a Changelog][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:
1. Draft a [new GitHub release][github-release].

1. Tweet about the release from the [@bourbonsass] Twitter account, e.g.

> We’ve released Bitters {release_title}: {release_link}
1. If needed, update the [contributing page] and [website example page].
1. If needed, update the [contributing page].

[Keep a CHANGELOG]: http://keepachangelog.com
[keep-a-changelog]: https://keepachangelog.com/en/1.0.0/
[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 b74dd24

Please sign in to comment.
You can’t perform that action at this time.