Rule Engine Versioning

[chowsanthony]

Document Information

Version	Date	Status
1	June 19, 2023	Draft

Effective Date

To be determined.

Target Audience

1. CORE Scrum teeam

Introduction

Software release versioning is an integral part of the software development lifecycle that aids in tracking and managing different stages of software evolution. It assists developers, users, and systems in distinguishing between varying iterations of the same software product. This document sheds light on versioning scheme and principles.

Versioning scheme

• We are basing it on semver 2.0.0 guidelines (https://semver.org/).
• We use the x.y.z notation, where as x: major, y: minor, z: patch.
• We may utilize pre-release identifiers such as alpha and beta to denote the developmental stages of a software version. For example, a pre-release version could be labeled as 1.1.0-alpha.

General principles

• We consider 1.0.0 as General Availability (GA).
• While we are in 0.y.z, breaking changes are often and frequent. Increment the y number.
• We will have a 1.0.0 release when we feel the engine to be super robust.
• When a release introduces backward-incompatible changes, increment the x number.

Other considerations

This section serves as prompts for additional considerations to improve the overall process. The outcome of these discussions may contribute to the content of this document.

• How do we automate the generation of changelog for each release?
  • Write changelog-friendly commit messages with predetermined tags
  • Refer to Conventional Commits (https://www.conventionalcommits.org/en/v1.0.0/).
• Is npm's standard-version or release-please on GitHub applicable?