Versioning

Versioning of releases made for core Switch services

This document provides guidelines regarding the versioning strategy used for the releases of Mojaloop Open Source repositories corresponding to the Switch services.

Versioning Strategy

Standard for PI-11 and beyond

1. Starting PI-11 (27th July, 2020) the Versioning guidance is to move to a versioning system that is closely aligned with Semantic versioning by removing the PI/Sprint dependency. So starting 11.x.x, the proposal is to move to pure SemVer.
2. At a high-level, we will still follow the vX.Y.Z format, but X represents ‘Major’ version, Y represents ‘Minor’ version and Z represents ‘patch’ version. Minor fixes, patches affect increments to ‘Z’, whereas non-breaking functionality changes affect changes to ‘Y; breaking changes affect the ‘X’ version.
3. Along with these, suffixes such as “-snapshot”, “-patch”, “-hotfix” are used as relevant and on need basis (supported by CI config).
4. So starting with 11.0.0 (primarily for Helm, but for individual services as well) for PI-11, the proposal is to move to pure SemVer.
5. This implies that for any new release of a package/service below X=11 (for existing repositories and not new ones) will first be baselined to v11.0.0 and from then on follow standard SemVer guidelines as discussed above. For new projects or repositories, versioning can start from v1.0.0 (after they reach release status)

Versioning Strategy used until PI-10

1. The Mojaloop (up to PI-10) versioning system is inspired by the Semantic Versioning numbering system for releases.
2. However, this is customized to depict the timelines of the Mojaloop project, based on the Program Increment (PI) and Sprint numbers
3. For example, the release number v5.1.0 implies that this release was the first one made during a Sprint 5.1, where Sprint5.1 is the first Sprint in PI-5. So for a version vX.Y.Z, X.Y is the Sprint number where X is the PI number and Z represents the number of release for this specific repository. Example v4.4.4 implies that the current release is the fourth of four releases made in Sprint 4.4 (of PI-4)

Current Version

The currrent version information for Mojaloop can be found here.

Sprint schedule for PI-13

Below is the Sprint schedule for Program Increment 13 which ends with the PI-14 Community event in April 2021.

Sprint schedule for PI-12

Below is the Sprint schedule for Program Increment 12 which ends with the PI-13 Community event in January 2021.

Previous Sprint Schedules:

Sprint schedule for PI-11

Below is the Sprint schedule for Program Increment 11 which ends with the PI 12 Event.

Sprint schedule for PI-10

Below is the Sprint schedule for Program Increment 10 which ends with the PI 11 Event. Please use this as guidance during the versioning and release processes.

PI-9

PI-8

Notes

1. A new release for helm repo is made based on the feature and configuration changes made to core services and requirements from thhe Community.