loading...
Cover image for Semantic Release Automation - Part 1 - Understanding Semantic Version

Semantic Release Automation - Part 1 - Understanding Semantic Version

abdelrahmanahmed profile image Wahdan Updated on ・3 min read

Semantic Release Automation (3 Part Series)

1) Semantic Release Automation - Part 1 - Understanding Semantic Version 2) Semantic Release Automation - Part 2 - Setup Semantic Release Package 3) Semantic Release Automation - Part 3 - deploy to github pages

Have you ever wondered why any software package must have a version number? what is the difference between this version 1.0.0 number to this one 1.1.0?

Table Of Contents

Motivation

Alt Text
In javascript world, we have multiple package managers such as npm and yarn that handle your dependencies in your application. They provide a bunch of features to make your life easier, you can view these features on their websites.

With each package you installed in your application, there is a version number on each one of them.

What Is Semantic Versioning

Semantic versioning is a set of rules that dictate how version numbers are assigned and incremented. The image below describes what each number means:

Semantic Versioning

So if:

  • The first number from the right is incremented (patch). It means that there is a new hotfix/bugfix on this package.
  • The middle number is incremented (minor). It means that there is a new feature.
  • The last number from the left is incremented (major). It means that there is a breaking change.

It is important to highlight that it should be safe to update the package if there are any patch/minor changes (backward compatibility). If you find any major change, you have to double-check the package's release notes before upgrading its version.

Updating Your Package Version

There are two ways to update your package version, either to do it manually or by using npm commands or yarn commands. If you don't have any package yet you can create a new one by running this command:

npm init

or

yarn init

Assuming that the current version of your package.json is 1.0.0. If you run this command

npm version patch //1.0.1

This will update your package.json version and it will be set to 1.0.1.What is happened under the hood is npm will read your package.json version and will update its value. You may also like to try out these commands and see the results

npm version minor //1.1.0
npm version major //2.0.0

so whenever you have done with your feature/bugfix or any other change you can use run these commands to update your package version. but there is a problem here, what if we are working within a team and each one of them will run these commands, what is the final version? how to avoid this conflict? even if you are working alone, trust me life is too short to run these commands every time after finishing your stuff.

About Semantic Release Package

semantic release package is designed to automate your releases with many features like:

  • Create and update CHANGELOG file
  • Publish your packages to any registry.
  • Update package.json version.
  • Integration with any continues integration tool.
  • Integration with GIT Hosted services.

In my next article, I am going to explain how to set up this package in your project and automate your workflow.

Semantic Release Automation (3 Part Series)

1) Semantic Release Automation - Part 1 - Understanding Semantic Version 2) Semantic Release Automation - Part 2 - Setup Semantic Release Package 3) Semantic Release Automation - Part 3 - deploy to github pages

Posted on May 20 by:

abdelrahmanahmed profile

Wahdan

@abdelrahmanahmed

Full stack software engineer with a flair for creating elegant solutions with the least amount of time.Exceptional problem solver with an aptitude for troubleshooting and the ability to quickly master

Discussion

markdown guide