How We Version Our Code

Software versioning is the process of assigning either unique version names or unique version numbers to unique states of computer software. That is what Wikipedia says about versioning code. Here in Sanmark, we religiously version our code.

Our versioning method is tightly fitted with our source control system, which is Git. It won’t be a surprise that Git — and other tools of it’s kind — are called “version control systems” as well.

A Little Bit About Our Git Usage

We follow a Git branching model that is close Gitflow method. We have a master branch, that will have only production ready code. Our dev branch is home to new completed features. We create feature branches off dev when we create new features. Our bug fix branches derive from master branch.

I hope to write more about our Git branching model in the next post.

Version Numbering Method

Our version numbering method is very similar to that of Semver.

Version numbers contain three parts, in which the first is the major version, second is the minor version, and the third is the patch version.

Major version is only incremented when backword incompatible changes are made. Major versions can also include minor and patch changes.

Minor version is incremented when new features are introduced. Minor versions can also include patch changes.

Patch version is only incremented when bug fixes and other patches are added to the code.

Versioning During Alpha and Beta Periods

During alpha period, we suffix our Major.Minor.Patch versions with “-a-AlphaMajor.AlphaMinor.AlphaPatch“.

So it’ll look like this:

Major.Minor.Patch-a-AlphaMajor.AlphaMinor.AlphaPatch
1.0.0-a-1.4.9

For beta, just replace “a” with a “b”.

The first released version our code will be “1.0.0-a-1.0.0” and it’ll increment from their.

Git Tag and Commit Message

Once we decide upon a version number, we will use it as the commit message of the merge commit that merges the dev or bug-fix branch into master. Once merged, we will also put a tag to that merge commit with the same thing.

Supun “Buddy” Budhajeewa is the COO of Sanmark.
Share this Post:

Leave a Comment

Your email address will not be published!, ( required fields are marked ).