RELEASING.md

Releasing

Releases are automated via a GitHub Actions workflow. Only people with permission to push to release/* branches can make releases.

See Cucumber release process for the whole process.

Preparation

1. Decide what the next version should be according to semver

   export next_release=<version> # <- insert version number here

2. Update the version.sbt file with version to release:

   echo "ThisBuild / version := \"$next_release\"" > version.sbt

3. Update the CHANGELOG and documentation, commit and push:

   make prepare-release

Release

1. Push to a new release/* branch to trigger the release-* workflows

   git push origin main:release/v$next_release

2. Wait until the release-* workflows in GitHub Actions have passed
3. In version.sbt, bump the patch version and append -SNAPSHOT (e.g. 1.2.4-SNAPSHOT) and commit/push