Versioning for open source library

Versioning for open source library

Few weeks ago I explained how Gitversion can be used to apply semantic versioning to projects based on commit and tag history.
Today I will dive deeper in the purpose of versioning and introduce a flow which can be followed to version open source project libraries by looking into four important parts in the lifecycle of an open source library.

  1. Version with Semantic versioning
  2. Branching strategy and Commits
  3. Continuous Integration and Releases

1. Version with Semantic versioning

Semantic versioning is ideal for versioning libraries. It is formed by three numbers {major}.{minor}.{patch}. Each number is used to indicate to the user the level of safety for upgrading the library.

  • Upgrade of the major is risky and has chances to contain breaking changes, therefore looking at release notes or looking for migration would be recommended.
  • Upgrade of the minor has lesser risk and can be used to show availability of new features.
  • Upgrade of the patch is not risky and is used to push patches.

Following this format allows to have a predictable version number which can be used by applications or libraries to setup upgrade rules and avoiding version lock.

For example, consider the following:

  • we build a library A on version 1.5.0
  • library B references our library A on version 1.5.0
  • application A references library A on version 1.5.0 and library B

We release a new version 1.6.0 with a new feature which application A wants to use.
If the versions aren’t predictable, both application A and library B will need to upgrade to library A 1.6.0.
With Semantic version, the version number is predictable and a bump of the minor specify no breaking changes. Therefore a compatibility rule on library A can be set to support any version of library B 1.x.x as long as it is higher 1.5.0.

The initial commits before release follow the version 0.x.x. Before the first major bump any releases are to be considered as alpha.

2. Branching strategy and Commits

For a library, the easiest way is to manage everything around a single master branch and make any changes in a branch (or fork in Github) which will be merged via pull-request.

  • When new features need to be added, a branch is made out of master and pull-request'd back into master
  • When bug fixes need to be made, a branch is made out of master and pull-request'd back into master
  • When an open source contribution on GitHub occurs, the repository is forked and work is done on forked repository master and pull-request'd back into the main repository master

Every single commit has a version attributed to it. This is handle as such:

  • For each commit on master, the version format is constructed as such {major}.{minor}.{patch}+{commit}. For example, for the first commit after release tag 1.2.0, the version will be 1.2.1+1 while for the fifth commit it will be 1.2.1+5
  • For each commit on a branch, the version format is constructed as such {major}.{minor}.{patch}-{branch}+{commit}. For example, 1.2.1-mybranch.1+1, 1.2.1-mybranch.1+5 or 1.2.1-mybranch.1+3
  • Similarly for pull requests, 1.2.1-PullRequest.1+1

Once the branches and pull requests are merged, the resulting merge is another commit which then has an attributed version +{commit}.

Having a version for each commit becomes very handy when working in a continuously integrated pipeline which we will see next.

3. Continuous Integration and Releases

Continuous Integration is a must for open source projects. We must be able to know that master branch is always in a workable state. We also must ensure that all pull-requests are valid and do present a danger tobreak master. And lastly, we must ensure that other branches created to develop new features are also valid. To do that we would setup a CI server or use a service like Appveyor.

This is where a unique version for each commit is handy as on each commit pushed to the repository, a build will be triggered where the name of the build will be set to the version of the commit. This allows us to easily identify how the build relates to the repository as we will be able to know for which branch, for which version and which commit from the last release is the build trigger for.

The last important point is to handle releases. Since the library code changes all occur on master branch, we do not want to operate in a continuous delivery approach were every change on master would yield a release. Instead we can use tag to trigger a release which for a .NET library will produce a NuGet package .nupkg and generate a release on GitHub with the package attached to the release. Whenever we want to release, we tag the master branch with the exact release number.

Conclusion

Today we saw the different aspects of versioning for an open source library. We started by looking at semantic versioning and the reason why we would follow it. Then we moved to look into branching and how commits are versioned. Lastly we talked about continuous integration and releases. Hope you liked this post, in the next post, I will show how we can achieve the points we discussed today for a .NET library, see you next time!

Comments

Post a Comment

Popular posts from this blog

A complete SignalR with ASP Net Core example with WSS, Authentication, Nginx

SignalR with ASP Net Core SignalR is a framework from ASP NET Core allowing us to establish a two way communication between client and server. This two way communication allows the client to send messages to the server but more importantly allows the server to push messages to the client. SignalR makes use of Websocket when available else it falls back to SSE or pulling. Today we will focus on how to setup SignalR to work with WSS, Websocket secure and how we can authenticate the user requesting to connect to our SignalR hub via Webscoket. Getting started with SignalR SSL encryption for Websocket Secure WSS Websocket Authentication with Identity Server 4 SignalR behind Nginx 1. Getting started with SignalR The Hubs are the main components of SignalR. It is an abstraction of a two way communication available for both client and server. Public functions from the hub can be called from the server code and can be called from the client. The frontend NPM package @aspnet/signalr
Keep reading

Microsoft Orleans logs warnings and errors

Microsoft Orleans logs warnings and errors Microsoft Orleans is a framework which helps building distributed system by implementing the actor model together with the concept of virtual actors, taking care of availability and concurrency. If you are unfamiliar with Microsoft Orleans, you can look at my previous blog post explaining the benefits of Microsoft Orleans . Even though Orleans promises to abstract the distributed system problems, there are instances where errors arise without us being able to understand what is going on. Lucky us, the logs are well documented… but only for those who can decrypt them. Today I will go through some of the errors and warnings which can be seen from silo and client so that you too can undestand what is going on. Enjoy! The code used to produce those errors can be found on my GitHub https://github.com/Kimserey/orleans-cluster-consul . 1. Client logs Logs on client appears with address {ip}:0 . 1.1. Can’t find implementation of interface An un
Keep reading

One way to structure Web App built in F# and WebSharper

Image
Architecture for Web App built in F# and WebSharper F# + WebSharper is an awesome combination to build web application . The only problem is that if you want to build a web app larger than a to-do list, it’s hard to find examples to use as references. It is even harder to find tutorials that touches on overall design and answer questions like: How should I start? Where should I put the code? How should I separate the code, put it in different files, with different namespaces or modules? How many layers? Asking these questions at the beginning of the development is important. All these questions if answered correctly will lead to a good structure for the application. Answered incorrectly, or not even asked, will most likely lead to unmaintainable/fragile/rigid (or whatever bad adjectives for coding) code. Over the last few months, I have been working on a web app built in F# with WebSharper and came out with an architecture that caters to extensions and decoupling. Today, I wil
Keep reading