Skip to content

Gem Publishing Checklist

Michael Telford edited this page Oct 29, 2024 · 22 revisions
  • Ensure a clean branch of master and create a release branch --OR-- git rebase -i master into your existing development branch. Either way, no conflicts should exist and you should be happy with the commit history.
  • Run bundle exec toys rubocop -A (if necessary), manually verifying the changes.
  • Update standalone files (if necessary): README.md, wgit.gemspec etc.
  • Increment the version number (in version.rb) and update the CHANGELOG.md.
  • Run bundle to update the dependencies and the version number.
  • Run bundle exec toys compile and ensure acceptable warnings.
  • Run bundle exec toys test infinite_crawl_loop and ensure it's green.
  • Run bundle exec toys ci and ensure it passes.
  • Commit changes with message Releasing wgit v<version>.
  • Run bundle exec toys install and manually test the gem from outside the Wgit repo.
  • Merge your development branch into master. Push the commits to origin master.
  • Wait for and ensure the CI build passes.
  • Ensure the README badges are all green and looking good.
  • Run bundle exec toys release to tag, build and push everything to Github and Rubygems.
  • Verify the CI release build is green and that the gem is available on rubygems.org.
  • Clean up any obsolete branches (both local and remote).