RELEASE.md

Releasing

Before You Begin

Ensure your local workstation is configured to be able to Sign commits.

Local Release Preparation

Checkout latest code

Make sure local and remote state are sync:

$ git checkout master
$ git pull origin master
$ git push origin master

Test

Make sure all test pass and docs are updated

$ rake fmt test build test:e2e

There are some extra steps to check that everything else is working as expected

• Container

  $ rake container:build

• Demo

  $ rm -fr demo
  $ rake demo:serve
  $ open localhost:4000

Bump release

• Update CHANGELOG.md:
  • Add a new version header at the top of the document, just after # [Unreleased]
  • Update links at bottom of changelog
• Bump version in shard.yml.
• Bump version in src/medup/version.cr.

Commit and tag

Create a release commit and tag

$ export RELEASE_VERSION=x.y.z
$ git commit -a -S -m "Release v${RELEASE_VERSION}"
$ git tag -s "v${RELEASE_VERSION}"

Push

$ git push origin master --follow-tags

Github Release

Create a new release in Github:

• Title should equal to tag name. Example: v0.1.3
• Description should have a text from Changelog

Container

Create and push container image to DockerHub:

$ rake container:push

Update Homebrew versions

• Update homebrew-medup manifest

  1. Update version string to your released version;
  2. Update url with new release tag;
  3. Update sha256 from release archive file;

• Do a manual check of installing command line via brew

  1. While in the homebrew-medup directory...

     $ brew install ./medup.rb --debug

     Note: it's normal to get some errors when homebrew attempts to load the file as a Cask instead of a formula, just make sure that it still gets installed.
  2. Check installed version

     $ medup --version

• Commit and push changes to master branch