Skip to main content

Understanding Scispot's Semantic Versioning System

S
Written by Satya Singh
Updated over 2 months ago

Welcome to our community article on how Scispot uses semantic versioning! If you've ever wondered how we number our Scispot releases—like why we go from version 1.2.3 to 1.3.0 or 2.0.0—this article is for you. We're committed to transparency and predictability in our updates, so we follow a structured system called Semantic Versioning. This helps you, our Scispot users, know what to expect with each new release.

In simple terms, Semantic Versioning uses a three-part version number: MAJOR.MINOR.PATCH (for example, 2.5.1). Each part has a specific meaning, and we increment them based on the type of changes we're making to Scispot.

What Each Part of the Version Number Means

Here's how we define and use each component:

  • MAJOR Version (e.g., from 1.x.x to 2.0.0):
    This is the big one! We increment the MAJOR version when we introduce signficant changes to Scispot. These are updates that might require you to adjust your setup, workflows, or integrations because they're not backwards-compatible with previous versions. For instance, we might overhaul a key Scispot feature, remove deprecated functionality, or change how our API works in a way that could affect existing integrations.
    Major releases are planned carefully and announced in advance to give you time to prepare. We aim to keep these infrequent to minimize disruption.

  • MINOR Version (e.g., from 1.2.x to 1.3.0):
    These are our weekly updates to Scispot. This includes new features, enhancements, or improvements that are fully backwards-compatible. You won't need to make any changes on your end, as these should "just work" with your current Scispot setup. We'll highlight these in our weekly changelog so you can see what's new.

  • PATCH Version (e.g., from 1.2.3 to 1.2.4):
    Patches are for hotfixes and mid-week patches—quick fixes to address bugs, security issues, or minor tweaks in Scispot that don't add new functionality or change existing workflows. We deploy patches as needed throughout the week to keep Scispot running smoothly, ensuring stability without waiting for the next full update.

Scispot's Release Schedule and Changelog

To keep everything predictable:

  • Weekly Updates: We push out minor (and sometimes patch) releases for Scispot on a weekly basis. These include all the latest improvements and fixes from the past week.

  • Changelog: Every Monday, we publish a detailed changelog on our Scispot community articles which can be accessed here or through an in-app notification that appears every Monday. This includes the new version number, a summary of changes, and highlights of what's new, fixed, or improved in Scispot. Check it out to see if a major breaking change is on the horizon or just some handy new features to make your workflow a little smoother.

If you have questions about a specific Scispot release or our versioning system, please feel free to contact us for more details.

Did this answer your question?