Demystifying Semantic Versioning

#webdev #javascript #react #programming

In this section, we’ll cover the basics of Semantic Versioning — what it is, the various types of versions, and an in-depth exploration of version upgrades. We’ll also discuss how these versioning practices can impact our code. Let’s dive right in! 💻✨

🤔 What is Semantic Versioning ?
Sematic Versioning is a way to specify and convey the changes made in the software / packages based on it’s version number.

🖋️ Version Number Structure

example: if version number of any dependency is 2.6.3
Here ,

Major version number is 2
Minor version number is 6
Patch version number is 3
MAJOR Version:
Indicates significant updates that may break existing functionality or APIs.
Increments for backward incompatible changes.

Backward Incompatibility : It refers that the new updated version is not fully compatible with the older version as there might be some structural changes in code or removal of the some feature

// Version 1.0.0 function calculateSum(a, b) { return a + b; } function calculateProduct(a, b) { return a * b; } // Version 2.0.0 function calculateSum(a, b) { return a + b; } // calculateProduct function is removed in this version

MINOR Version: Indicates the introduction of new functionality without breaking existing features.

Increments for backward-compatible additions of features.

example: ejs : 3.2.9 ejs: 3.4.9
Backward-Compatibility : It refers to ability of a newer version of software to work seamlessly with system or code that was designed for older version.

`// Version 1.0.0
function calculateSum(a, b) {
return a + b;
}
In Version 1.1.0, a backward-compatible change is made by adding a new function, calculateAverage , without modifying or removing any existing functionality.

// Version 1.1.0
function calculateSum(a, b) {
return a + b;
}

// New backward-compatible feature added
function calculateAverage(a, b) {
return (a + b) / 2;
}`
3.PATCH Version:
Indicates the correction of issues without introducing new features mostly done for Security and Bugs fixes

example: ejs : 3.3.1 ejs: 3.3.2

Beta Version: A pre-release version for testing, signaling that it’s not yet a final, stable release. [beta is often used to indicate a version that is still in testing or development.]

{ "dependencies": { "library": "2.0.0-beta.1" } }
Beta versions invite users to test upcoming features and report issues before the stable release, allowing developers to gather feedback and ensure software readiness for widespread use.

Metadata: Metadata provides additional information about the build or release but does not affect the previous version feature or compatibility.

{ "dependencies": { "library": "1.2.3+build456" } }
😀 Let’s see what is Version Upgrade:

Caret ( ^ ) : Allows only MINOR & PATCH version upgradation automatically.
example:
{ "dependencies": { "ejs": "^3.3.1" } } ejs: 3.3.2 // allowed Patch Version fix ejs: 3.4.2 // allowed Minor Version fix ejs: 4.1.0 // not allowed Major Version fix