Skip to content

Versioning & Deployment

Jump to bottom
Timo Bögner edited this page Jul 15, 2021 · 6 revisions

Versioning

Versioning is automated with help from GitHub Actions, semantic-release and the Git-flow branching Model.

Branches

According to Git-flow we have the following permanent branches with special roles:

  • develop: Reflects the current development status. Feature branches are created from this and merged back to it, when complete.
  • release: Reflects the current testing status. When a stable state is reached on develop branch, it can be merged to release. This will result in creating a release candidate.
  • main: Reflects the current productive status. When a release candidate is well tested, it can be merged (from release) to main. This will result in creating a productive release. Furthermore hot fix branches can be created from the main branch, when critical bugs have to be fixed. After merging them back to main they should be also merged back to release and develop.

Determining version string

The version number follows the pattern major.minor.patch[-postfix] (Semantic Versioning) and is determined by semantic-release automatically from analyzing the commit comments by scanning for special keywords. Therefore we have the important convention to choose on of the following key words as first statement in each commit message (followed by a colon):

  • chore: TO BE DESCRIBED
  • fix: for bug fixes, leads to increment in patch
  • feat: for features, leads to increment in minor
  • BREAKING CHANGE: for incompatible changes, leads to increment in major

Publishing

The services / deployment units are bundled as docker images and uploaded to a public docker hub repository with name inoeg. This publishing process is triggered by merging / pushing commits to the special branches mentioned above. A push to

  • develop leads to simply publishing the images with the floating tag 'develop'
  • release or main leads to determining a new version number as described above (in case of release with an RC-postfix) and publishes the images with the following tags:
    • exact version string
    • major.minor (floating tag)
    • major (floating tag)
    • fix string 'latest' (floating tag)

Deployment

Deployment is automated with help from GitHub Actions, Maven, Docker and Watchtower.

Clone this wiki locally