Skip to content

Latest commit

 

History

History
15 lines (12 loc) · 1.2 KB

MAINTENANCE.md

File metadata and controls

15 lines (12 loc) · 1.2 KB
Raw

This file describes various maintenance tasks, relevant for project maintainers only.

Release a new version

It currently happens monthly, around the beginning of each month. We don't need to stick to this cadence strictly, the goal is to publish small frequent updates.

  1. Remove -SNAPSHOT for version starting from /github-workflows-kt/build.gradle.kts. By building the whole project with ./gradlew build, you will learn what other places need to be adjusted. Once done, create a commit using this pattern for commit message: chore: prepare for releasing version <version>.
  2. Once CI is green for the newly merged commits, create and push an annotated tag: 
    COMMIT_TITLE=`git log -1 --pretty=%B`
VERSION=${COMMIT_TITLE#"chore: prepare for releasing version "}
git tag -a "v$VERSION" -m "chore: release version $VERSION" && git push origin "v$VERSION"
  3. On main branch, change version to prepare for the next development cycle, e.g. if it was 0.20.1-SNAPSHOT before and we released it as 0.21.0, change the version to 0.21.1-SNAPSHOT.
  4. Ensure that the release job has succeeded.