releasing.md

Releasing

Releases are available on Sysl's GitHub releases page and on package registries (e.g. Docker Hub).   Sysl is using GitHub Actions as continuous integration (CI) and continuous deployment (CD) system.  

Steps to publish new release

1. Any merged PR on master will trigger the Generate-Tag workflow. It will generate and push the respective minor version tag. We follow Semver for versioning.

2. The version tag push event then triggers the Release workflow to publish release to Sysl's GitHub releases page (with changelog) and Docker Hub.

   Most of the release process is automated via GoReleaser. GoReleaser creates and deploys sysl-X.Y.Z-Os-Arch.tar.gz and sysl-X.Y.Z-Windows-Arch.zip to the Sysl Github Release page. It also updates sysl-homebrew with the latest release. See GoReleaser config file for further details.

   The release workflow also pushes Sysl's Docker Images anzbank/sysl:latest and anzbank/sysl:X.Y.Z to Docker Hub.

A tested example

• The new release proposal PR: #617
• The commit which merges new release PR: https://github.com/anz-bank/sysl/commit/edd3c4ee6cab7bcf99d580efef0e14669a597374
• The triggered GitHub workflow which generates tag: https://github.com/anz-bank/sysl/runs/451818569?check_suite_focus=true
• The triggered GitHub workflow which publishes respective release: https://github.com/anz-bank/sysl/runs/451819073?check_suite_focus=true
• The published binary release: https://github.com/anz-bank/sysl/releases/tag/v0.6.2
• The published Docker image: https://hub.docker.com/r/anzbank/sysl/tags?page=1 (image latest and 0.6.2)