From 256157cd42a088dd268c9d4d45fd538ca2f98131 Mon Sep 17 00:00:00 2001 From: Rick Bradley Date: Mon, 5 May 2014 13:46:28 -0500 Subject: [PATCH 1/3] add release instructions to README --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index bee635e1..0e2c060c 100644 --- a/README.md +++ b/README.md @@ -134,3 +134,18 @@ Any of the extensions defined are valid but the first in this array should be th Sometimes getting the tests running can be too much work, especially if you don't have much Ruby experience. It's okay: be lazy and let our build bot [Travis](http://travis-ci.org/#!/github/linguist) run the tests for you. Just open a pull request and the bot will start cranking away. Here's our current build status, which is hopefully green: [![Build Status](https://secure.travis-ci.org/github/linguist.png?branch=master)](http://travis-ci.org/github/linguist) + +### Releasing + +If you are the current maintainer of this gem: + + 0. Bump gem version in github-linguist.gemspec. For example, [like this](https://github.com/github/linguist/commit/97908204a385940e47251af9ecb689e8f6515c48). + 0. Make a PR to github/linguist. For example, [#1075](https://github.com/github/linguist/pull/1075). + 0. Cut a gem: `gem build github-linguist.gemspec` + 0. Testing: + 0. Bump the Gemfile and Gemfile.lock versions for an app which relies on this gem + 0. Install the new gem locally + 0. Test behavior locally, branch deploy, whatever needs to happen + 0. Merge github/linguist PR + 0. Tag `vx.xx.xx` release on github/linguist; push tag + 0. Push to rubygems.org -- `gem push github-linguist-2.10.12.gem` From 3f1dc71cc2fbe33377cec3b35287f3189a09e6a6 Mon Sep 17 00:00:00 2001 From: Rick Bradley Date: Mon, 5 May 2014 13:51:36 -0500 Subject: [PATCH 2/3] improve release instructions --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0e2c060c..2c076650 100644 --- a/README.md +++ b/README.md @@ -139,9 +139,13 @@ Here's our current build status, which is hopefully green: [![Build Status](http If you are the current maintainer of this gem: + 0. Create a branch for the release: `git checkout -b cut-release-vxx.xx.xx` + 0. Make sure your local dependencies are up to date: `bundle install` + 0. Ensure that samples are updated: `bundle exec rake samples` + 0. Ensure that tests are green: `bundle exec rake test` 0. Bump gem version in github-linguist.gemspec. For example, [like this](https://github.com/github/linguist/commit/97908204a385940e47251af9ecb689e8f6515c48). 0. Make a PR to github/linguist. For example, [#1075](https://github.com/github/linguist/pull/1075). - 0. Cut a gem: `gem build github-linguist.gemspec` + 0. Build a local gem: `gem build github-linguist.gemspec` 0. Testing: 0. Bump the Gemfile and Gemfile.lock versions for an app which relies on this gem 0. Install the new gem locally From 452cfd32d7fe15e4c430c354b8395c09c17af43a Mon Sep 17 00:00:00 2001 From: Rick Bradley Date: Mon, 5 May 2014 13:56:08 -0500 Subject: [PATCH 3/3] one more tweak --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2c076650..9e68a909 100644 --- a/README.md +++ b/README.md @@ -151,5 +151,5 @@ If you are the current maintainer of this gem: 0. Install the new gem locally 0. Test behavior locally, branch deploy, whatever needs to happen 0. Merge github/linguist PR - 0. Tag `vx.xx.xx` release on github/linguist; push tag + 0. Tag and push: `git tag vx.xx.xx; git push --tags` 0. Push to rubygems.org -- `gem push github-linguist-2.10.12.gem`