Smile CDR Versioning
Smile CDR uses Calendar Versioning for releases, along with a patch number indicator. This means that our releases will have the format YYYY.MM.RXX
or YYYY.MM.PRE-XX
, according to the following rules:
YYYY
– This indicates the year of the release, e.g. 2023
.MM
– This indicates the month of the release, e.g. 11
.RXX
– This indicates the micro version (or patch version) of a given Generally Available release. For each YYYY.MM
, this starts at R01
, and can increase to any amount.PRE-XX
– This indicates the micro version of a given Prerelease. For each YYYY.MM
, this starts at PRE-01
, and can increase to any amount.A Generally Available Release will always have the format YYYY.MM.RXX
. These releases undergo heavy automated testing, as well as manual verification from multiple teams. These releases are sanctioned for use in production environments, and are fully supported by our support team.
After a quarterly Generally Available release, it is inevitable that minor adjustments must be made. This could be for various reasons, including:
To deal with this, patches are provided to these Generally Available releases. These have the same YYYY.MM.RXX
format as the initial Release, where XX
will be continuously increasing as more releases are made, e.g. (R02, R03, R04, etc).
These releases contain hyper-targeted fixes to specific issues found with a given release, which are clearly labeled on the release page. Breaking API changes will never be introduced in a patch release, and it is always safe to upgrade from R01 to any subsequent RXX without fear of breaking changes.
When choosing a version of Smile CDR, you should always select the most recent patch version. For example, if you wanted to upgrade to 2024.02, and the available versions are:
2024.02.R01
2024.02.R02
2024.02.R03
2024.02.R04
You should always select 2024.02.R04
.
While Generally Available releases are robustly tested and vetted, it is often useful to be able to test bleeding-edge features before they reach production-readiness. To this end, we support a set of releases called Prereleases
. Prereleases will contain new features and fixes as they are added to the product by the development teams. These have the format YYYY.MM.PRE-XX
.
There are generally anywhere from 30 to 80 Prereleases between official quarterly Generally Available releases.
Generally available releases occur quarterly for R01 versions, in February, May, August, and November. Generally speaking, they are released on the third thursday of the month. As an example, during the year 2024, the following Generally Available releases will be created:
2024.02.R01
– Released in February 20242024.05.R01
– Released in May 20242024.08.R01
– Released in August 20242024.11.R01
– Released in November 2024Patches to Generally Available releases occur on no fixed schedule, and are created as critical issues are identified.
Prereleases are created on demand as new features are added to the product. This occurs overnight, and Prereleases are made available the following morning. There can be gaps between Prereleases if no new features have been added that particular day.
Here's an example of what a a time-series of releases from Smile CDR might look like.
Date | Version | Type | Notes |
---|---|---|---|
2024/11/10 | 2025.02.PRE-01 | Prerelease | First Prerelease of the 2025.02 release. Note the date. This is released |
2024/11/11 | 2025.02.PRE-02 | Prerelease | Standard Nightly Prerelease |
2024/11/12 | 2025.02.PRE-03 | Prerelease | Standard Nightly Prerelease |
2024/11/15 | 2025.02.PRE-04 | Prerelease | Standard Nightly Prerelease, note that none have occurred since 2024/11/12. This is fine, and normal |
2024/11/16 | 2025.02.PRE-05 | Prerelease | Standard Nightly Prerelease |
... | ... | ... | Many prereleases omitted for brevity |
2025/02/01 | 2025.02.PRE-44 | Prerelease | Standard Nightly Prerelease |
2025/02/16 | 2025.02.R01 | Generally Available | Generally Available Release |
2025/02/17 | 2025.05.PRE-01 | Prerelease | First Prerelease of 2025.05 |
2025/02/18 | 2025.05.PRE-02 | Prerelease | Standard Nightly Prerelease |
2025/02/25 | 2025.02.R02 | Generally Available | A critical issue was found in 2025.02.R01, and so a fix has been made, and a new Generally Available release has been created |
2025/02/18 | 2025.05.PRE-03 | Prerelease | Standard Nightly Prerelease |
... | ... | ... | Many prereleases omitted for brevity |
2025/05/17 | 2025.05.R01 | Generally Available | Generally Available Release |
2025/05/21 | 2025.08.PRE-01 | Prerelease | First Prerelease of 2025.08 |
2025/05/22 | 2025.08.PRE-02 | Prerelease | Standard Nightly Prerelease |
... | ... | ... | Many prereleases omitted for brevity |
2025/08/17 | 2025.08.R01 | Generally Available | Generally Available Release |
You are about to leave the Smile Digital Health documentation and navigate to the Open Source HAPI-FHIR Documentation.