Skip to content

Latest commit

 

History

History
100 lines (72 loc) · 2.64 KB

RELEASE.md

File metadata and controls

100 lines (72 loc) · 2.64 KB
Raw

Release procedure

This document describes how to release a new version of sabakan.

Versioning

Sabakan has two kind of versions: API version and schema version.

API version should follow semantic versioning 2.0.0 to choose the new version number. It is also used for archive versions.

Schema version is a positive integer. It must be incremented when some data format has been changed.

Prepare change log entries

Add notable changes since the last release to CHANGELOG.md. It should look like:

(snip)
## [Unreleased]

### Added
- Implement ... (#35)

### Changed
- Fix a bug in ... (#33)

### Removed
- Deprecated `-option` is removed ... (#39)

(snip)

Increment schema version

When a backward-incompatible change in the data structure which is stored in etcd is to be merged to main, the schema version must be incremented and conversion from old schema need to be implemented.

  1. Increment SchemaVersion in version.go by 1.
  2. Increment schema version at the top of docs/schema.md by 1.
  3. Add conversion method from old schema. Example: models/etcd/convert2.go.
  4. Call the conversion method from driver.Upgrade defined in models/etcd/schema.go.

Bump version

  1. Determine a new API/program version number. Then set VERSION variable.

    # Set VERSION and confirm it. It should not have "v" prefix.
$ VERSION=x.y.z
$ echo $VERSION

  2. Make a branch to release

    $ git checkout main
$ git pull
$ git checkout -b "bump-$VERSION"

  3. Edit CHANGELOG.md for the new version (example).

  4. Update Version constant in version.go.

  5. Commit the change and push it.

    $ git commit -a -m "Bump version to $VERSION"
$ git push -u origin HEAD
$ gh pr create -f

  6. Merge this branch.

  7. Add a git tag to the main HEAD, then push it.

    # Set VERSION again.
$ VERSION=x.y.z
$ echo $VERSION

$ git checkout main
$ git pull
$ git tag -a -m "Release v$VERSION" "v$VERSION"

# Make sure the release tag exists.
$ git tag -ln | grep $VERSION

$ git push origin "v$VERSION"

GitHub actions will build and push artifacts such as container images and create a new GitHub release.