diff --git a/RELEASING.md b/RELEASING.md index 23c3e9ebe6..8901f8e3d1 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -16,7 +16,7 @@ simple. We'll get this scripted someday, but until then it's better to have it written down then floating in a brain somewhere. -1. Do a git log since the last release to see what changed. You can scope it to +1. Do a `git log` since the last release to see what changed. You can scope it to `lib` to just pick up code changes and filter out Casks noise. Like this: `git log v0.25.0..HEAD lib` 2. Optionally run `developer/bin/project_stats ` for @@ -25,15 +25,18 @@ down then floating in a brain somewhere. whether to bump minor or patch based on whether or not features were added. 4. Populate the CHANGELOG with a new section for the release you are creating. Follow the patterns used elsewhere in the file. -5. Make a commit with CHANGELOG + version bump. - Like this: `git commit -m 'cut v0.26.0'` +5. Make a commit containing the CHANGELOG and version-bump. Like this: + ```bash + git add CHANGELOG lib/cask/version.rb + git commit -m 'cut v0.26.0' + ``` 6. Tag that commit, ensuring that you provide a message so we get an annotated tag. Like this: `git tag -m v0.26.0 v0.26.0` 7. Push the commit and the tag: `git push --follow-tags` -8. Hop to the GitHub project and click "Releases" then the link for your newly - pushed tag. Click the "Edit Tag" button in the top right corner of that - page. +8. Open your browser to . + Then click the link for your newly pushed tag. Click the "Edit Tag" button in + the top right corner of that page. 9. Paste the markdown summary from the CHANGELOG in the body of the release and click "Publish Release". 10. Rejoice! Have a :cookie:.