Skip to content

RELEASING.md

Latest commit

 

History

History
81 lines (51 loc) · 3.15 KB

RELEASING.md

File metadata and controls

81 lines (51 loc) · 3.15 KB

Releasing gcloud-ruby

The gcloud-ruby library uses semantic versioning. Replace the <prev_version> and <version> placeholders shown in the examples below with the appropriate numbers, e.g. 0.1.0 and 0.2.0.

After all pull requests for a release have been merged and all Travis CI builds are green, you may create a release as follows:

  1. Build the gcloud-ruby gem locally.
$ rake build
  1. Install the gcloud-ruby gem locally.
$ rake install

  1. Using IRB (not rake console!), manually test the gem that you installed in the previous step.

  2. Open the GitHub compare view in your browser.

open https://github.com/GoogleCloudPlatform/gcloud-ruby/compare/v<prev_version>...master

  1. Review the commits in the GitHub compare view, making notes of significant changes. (For examples of what a significant change is, browse the changes in the CHANGELOG.md.

  2. If you haven't already, switch to the master branch, ensure that you have no changes, and pull from origin.

$ git checkout master
$ git status
$ git pull --rebase

  1. Edit CHANGELOG.md. Using your notes from the previous step, write bullet-point lists of the major and minor changes. You can also add examples, fixes, thank yous, and anything else helpful or relevant. See gcloud-node v0.18.0 for an example with all the bells and whistles.

  2. Edit lib/gcloud/version.rb, changing the value of VERSION to your new version number.

  3. Commit your changes. Copy and paste the significant points from your CHANGELOG.md edit as the description in your commit message.

$ git commit -am "Bump for version <version> ... "
  1. Ensure again that you have every commit from origin master.
$ git pull --rebase
  1. Tag the version.
$ git tag -m 'v<version>' v<version>
  1. Push your commit.
$ git push
  1. Push your tag.
$ git push --tags

  1. On the gcloud-ruby releases page, click Draft a new release. Complete the form. Include the bullet-point lists of the major and minor changes from CHANGELOG.md. You can also add examples, fixes, thank yous, and anything else helpful or relevant. See gcloud-node v0.18.0 for an example with all the bells and whistles.

  2. Click Publish release.

  3. Check that the Travis CI build has passed for the version commit.

  4. Confirm that the gem for the new version is available on RubyGems.org.

  5. Confirm that the new version is displayed after "Latest release" on the gcloud-ruby gh-pages site.

High fives all around!