Skip to content

Publishing a maintenance release

Gregory Brown edited this page Feb 26, 2015 · 37 revisions
  • Verify that the code in the stable branch is what you want to release.
  • Ensure lib/prawn/version.rb matches the version you want to release.
  • Build the manual and do a quick visual skim of its contents to make sure it's working properly.
  • Run the tests on the stable branch. Make sure you can get a passing local build.
  • Check the latest Travis CI builds for the stable branch and make sure they match the current latest commit, and are green across all supported Rubies.
  • Test output in "Creating PDFs with Ruby" book. (Greg needs to do this for now)
  • Make sure CHANGELOG.md file in repository is fully up to date. Verify by looking at git history, even if it looks right.
  • If any new documentation was added to the manual in this release, upload a new version of the manual to the github pages website. (TODO: explain this in more detail)
  • If any new API docs were written, upload a new version to the github pages site. (TODO: explain this in more detail)
  • Tag the new release in git
  • Add a link to the relevant portion of the CHANGELOG on the github release tag
  • Build a new gem and upload to rubygems.org
  • Try to find someone else to install the gem and run it if possible, or at least do a "hello world" test at the minimum yourself.
  • Bump the stable version in lib/prawn/version.rb (for the next release).
  • Prepare a blog post for elmcitycraftworks.org (we'll later move these announcements to prawnpdf.org)
  • Announce on prawn-ruby mailing list and on Twitter. See previous announcements for examples.
  • Update development roadmap with a note about the release.
  • If you have the time to do it, now would be a good time to delete any branches that have either been merged or rejected.