2.7 KiB
Release Standards
Here's where we document how homebrew-cask is released.
Versioning
We attempt to follow Semantic Versioning as much as possible.
Since we are still pre-1.0, this essentially means that we bump the PATCH number when we fix bugs, and we bump the MINOR number when we add stuff. Pretty simple.
The script developer/bin/get_release_tag
can tell you the latest release
tag that exists and/or calculate the proposed next release tag. Docs are at
get_release_tag -help
.
Release Process
We'll get this scripted someday, but until then it's better to have it written down than floating in a brain somewhere.
- Do a
git log
since the last release to see what changed. You can scope it tolib
to just pick up code changes and filter out Casks noise. Like this:git log $(developer/bin/get_release_tag)..HEAD lib
- Decide whether to bump the minor or patch fields in the next tag, based on
whether or not features were added. Run the shell command
and make sure the value innew_tag=$(developer/bin/get_release_tag -next) # or -next -patch
$new_tag
is what you want. - Optionally run
developer/bin/project_stats release
for overall release stats. - Bump the
VERSION
string which is stored in the filelib/cask/version.rb
. It should match$new_tag
. - Populate the CHANGELOG with a new section for the release you are creating. Follow the patterns used elsewhere in the file.
- Make a commit containing the CHANGELOG and version-bump. Like this:
git add CHANGELOG lib/cask/version.rb git commit -m "cut $new_tag"
- Tag that commit, ensuring that you provide a message so we get an annotated
tag. Like this:
git tag -m "$new_tag" "$new_tag"
- Push the commit and the tag:
git push --follow-tags
- Unset
$new_tag
, you don't need it anymore.unset new_tag
- Open your browser to https://github.com/phinze/homebrew-cask/releases . Then click the link for your newly pushed tag. Click the "Edit Tag" button in the top right corner of that page.
- Paste the markdown summary from the CHANGELOG in the body of the release and click "Publish Release".
- Rejoice! Have a 🍪.
Things to Consider
The way brew update
works, users will always be tracking HEAD
in their tap.
This means that the latest updates to Casks are going to trickle out
immediately after push. This means there are times when we need to be
thoughtful about how we push out new or breaking functionality. As a pre-1.0
project we can still break backwards compatibility, but sometimes there might
be decisions we can make about releasing to make things easier on our users.
In general: go easy on the users!