Skip to content

Latest commit

 

History

History
31 lines (25 loc) · 1.43 KB

RELEASE.md

File metadata and controls

31 lines (25 loc) · 1.43 KB
Raw

Releasing a new version of octokit.rb

  1. Create a list of all the changes since the prior release
    1. Compare the latest release to master using https://github.com/octokit/octokit.rb/compare/`${latest}`...master
    2. Open the linked pull requests from all the Merge pull request #... commits
    3. For all non-documentation PRs, copy title (including pull request number) into markdown list items
    4. (optional, but nice) Sort into logical buckets, like "support for additional endpoints", "enhancements", "bugfixes"
    5. Reorganize to put the pull request number at the start of the line
  2. Ensure there are no breaking changes (if there are breaking changes you'll need to create a release branch without those changes or bump the major version)
  3. Update the version
    1. Update the constant in lib/octokit/version.rb
    2. Commit the version change and push directly to master
  4. (Optional) Run script/release with no parameters to execute a dry run of a release
  5. Run the script/release -r script to cut a release (this will run script/validate to perform the permission check)
  6. Draft a new release at https://github.com/octokit/octokit.rb/releases/new containing the curated changelog

Prerequisites

In order to create a release, you will need to be an owner of the octokit gem on Rubygems.

Verify with:

gem owner octokit

An existing owner can add new owners with:

gem owner octokit --add EMAIL