The Project | About Us | Contribute | Donations | License

HOME

Semantic Versioning (SemVer) is a versioning scheme for software that aims to convey meaning about the underlying changes with each new release. It uses a three-part version number: MAJOR.MINOR.PATCH.

Key Concepts

MAJOR version: Incremented when you make incompatible API changes.
MINOR version: Incremented when you add functionality in a backward-compatible manner.
PATCH version: Incremented when you make backward-compatible bug fixes.

Version Number Format

The version number format is MAJOR.MINOR.PATCH, where:

MAJOR: Introduces breaking changes.
MINOR: Adds new features without breaking existing ones.
PATCH: Fixes bugs without adding new features or breaking changes.

Example

1.0.0: Initial release.
1.1.0: Added new features in a backward-compatible manner.
1.1.1: Fixed bugs in a backward-compatible manner.
2.0.0: Introduced breaking changes.

Practical Examples

Example 1: Initial Release

{
  "name": "my-package",
  "version": "1.0.0",
  "description": "My first package"
}

Example 2: Adding a New Feature

{
  "name": "my-package",
  "version": "1.1.0",
  "description": "Added a new feature"
}

Example 3: Bug Fix

{
  "name": "my-package",
  "version": "1.1.1",
  "description": "Fixed a bug"
}

Example 4: Breaking Changes

{
  "name": "my-package",
  "version": "2.0.0",
  "description": "Introduced breaking changes"
}

Using Semantic Versioning with NPM

NPM (Node Package Manager) uses semantic versioning to manage package dependencies. When you specify a dependency in your package.json file, you can use various symbols to indicate the version range you are willing to accept.

Version Range Symbols

Exact Version: 1.0.0 - Only this version.
Caret (^): ^1.0.0 - Compatible with the latest minor and patch versions.
Tilde (~): ~1.0.0 - Compatible with the latest patch version.

Example `package.json`

{
  "name": "my-app",
  "version": "1.0.0",
  "dependencies": {
    "express": "^4.17.1",
    "mongoose": "~5.10.0"
  }
}

In this example:

express will be updated to any version that is 4.x.x but not 5.x.x.
mongoose will be updated to any version that is 5.10.x but not 5.11.x.

Practical Exercise

Exercise 1: Understanding Versioning

Given the following version numbers, identify the type of change (MAJOR, MINOR, PATCH):

1.0.0 to 1.1.0
1.1.0 to 1.1.1
1.1.1 to 2.0.0

Solution

1.0.0 to 1.1.0 - MINOR (added new features)
1.1.0 to 1.1.1 - PATCH (fixed bugs)
1.1.1 to 2.0.0 - MAJOR (introduced breaking changes)

Exercise 2: Updating `package.json`

Update the following package.json to use semantic versioning for dependencies:

{
  "name": "my-app",
  "version": "1.0.0",
  "dependencies": {
    "express": "4.17.1",
    "mongoose": "5.10.0"
  }
}

Solution

{
  "name": "my-app",
  "version": "1.0.0",
  "dependencies": {
    "express": "^4.17.1",
    "mongoose": "~5.10.0"
  }
}

Common Mistakes and Tips

Ignoring MAJOR changes: Always be cautious with MAJOR version updates as they can introduce breaking changes.
Overusing PATCH updates: Ensure that PATCH updates are truly backward-compatible bug fixes.
Not updating dependencies: Regularly update your dependencies to benefit from the latest features and security patches.

Conclusion

Semantic Versioning is a crucial concept for managing software versions and dependencies effectively. By following the SemVer guidelines, you can ensure that your software evolves in a predictable and manageable way. Understanding and using semantic versioning with NPM will help you maintain a stable and reliable codebase.

Semantic Versioning

Key Concepts

Version Number Format

Example

Practical Examples

Example 1: Initial Release

Example 2: Adding a New Feature

Example 3: Bug Fix

Example 4: Breaking Changes

Using Semantic Versioning with NPM

Version Range Symbols

Example `package.json`

Practical Exercise

Exercise 1: Understanding Versioning

Solution

Exercise 2: Updating `package.json`

Solution

Common Mistakes and Tips

Conclusion

Node.js Course

Module 1: Introduction to Node.js

Module 2: Core Concepts

Module 3: File System and I/O

Module 4: HTTP and Web Servers

Module 5: NPM and Package Management

Module 6: Express.js Framework

Module 7: Databases and ORMs

Module 8: Authentication and Authorization

Module 9: Testing and Debugging

Module 10: Advanced Topics

Module 11: Deployment and DevOps

Module 12: Real-World Projects

Semantic Versioning

Key Concepts

Version Number Format

Example

Practical Examples

Example 1: Initial Release

Example 2: Adding a New Feature

Example 3: Bug Fix

Example 4: Breaking Changes

Using Semantic Versioning with NPM

Version Range Symbols

Example package.json

Practical Exercise

Exercise 1: Understanding Versioning

Solution

Exercise 2: Updating package.json

Solution

Common Mistakes and Tips

Conclusion

Node.js Course

Module 1: Introduction to Node.js

Module 2: Core Concepts

Module 3: File System and I/O

Module 4: HTTP and Web Servers

Module 5: NPM and Package Management

Module 6: Express.js Framework

Module 7: Databases and ORMs

Module 8: Authentication and Authorization

Module 9: Testing and Debugging

Module 10: Advanced Topics

Module 11: Deployment and DevOps

Module 12: Real-World Projects

Example `package.json`

Exercise 2: Updating `package.json`