Samagra-Development / WarpSQL

WarpSQL
https://samagra-development.github.io/WarpSQL/
Apache License 2.0
16 stars 28 forks source link

Implement versioning strategy #117

Closed PiyushRaj927 closed 9 months ago

PiyushRaj927 commented 9 months ago

Currently, WarpSQL's versioning lacks a proper structure. It would be nice to formalize this process to alert users of breaking changes etc.

PiyushRaj927 commented 9 months ago

Proposal

I am proposing the following versioning strategy for the WarpSQL codebase, using the SemVer Specification.

MAJOR Version (v1.x.x):

For incompatible backward changes. Examples:

MINOR Version (vx.4.x):

For non-breaking feature additions. Examples:

PATCH Version (vx.x.1):

For bug fixes that are backward compatible.

Using this strategy, we can guarantee that upgrading to a MINOR/PATCHversion of WarpSQL will ensure backward compatibility.

singhalkarun commented 9 months ago

Let's also make this as a part of process

  1. Versioning for test/alpha release
  2. Naming conventions for bitnami and non-bitnami images
  3. Naming convention for different base postgres images

Can you create a docs folder and add a versioning document detailing all this, also please link that doc to readme.md?