Merge pull request #425 from Shopify/release-on-tags

Allow for creating canary releases by tagging commits

Author: driv3r

.github/workflows/release.yml

@@ -4,6 +4,8 @@ on:
   push:
     branches:
       - main
+    tags:
+      - canary/*
 
 jobs:
   build-debs:
@@ -45,7 +47,14 @@ jobs:
           echo "sha256sum:"
           cat ghostferry-$GITHUB_SHA.sha256sum
 
-      - name: Releasing Ghostferry to Github
-        run: gh release create --target ${GITHUB_REF#refs/heads/} -p release-${GITHUB_SHA::7} ghostferry*
+      - name: Releasing production Ghostferry
+        if: ${{ github.ref_type == "branch" && github.ref_name == "main" }}
+        run: gh release create release-${GITHUB_SHA::7} --target ${{ github.ref_name }} --prerelease ghostferry*
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Releasing canary Ghostferry
+        if: ${{ github.ref_type == "tag" && startsWith(github.ref_name, "canary/") }}
+        run: gh release create ${{github.ref_name}} --prerelease --verify-tag --notes-from-tag --latest=false ghostferry*
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [Unreleased]
+
+### Added
+
+- Changelog.
+
+## [1.1.0]
+
+Past releases.

README.md

@@ -82,3 +82,23 @@ or
 Run a specific test
 
 `DEBUG=1 ruby -Itest test/integration/trivial_test.rb -n "TrivialIntegrationTest#test_logged_query_omits_columns"`
+
+Releasing new version
+---------------------
+
+### Canary
+
+Tag your commit with `canary/*` and push, i.e.
+
+```bash
+git tag --sign --message="Initial support for UUIDs as pagination keys" canary/v1.1.2-uuid-pagination-keys-alpha-1
+git push origin --tags
+```
+
+This will create the release named by tag.
+
+### Production
+
+Final releases are created automatically on merge to `main` branch, they will end up with `release-SHA` name.
+
+Remember to update version prior to bigger releases in `Makefile` along with updating the `CHANGELOG.md`.