-
Notifications
You must be signed in to change notification settings - Fork 11
Add new blog post for versioning #195
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
guanzhousongmicrosoft
merged 4 commits into
documentdb:main
from
alaye-ms:users/alaye/versioning-blog
Oct 2, 2026
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| --- | ||
| title: "Long-term support or development? An explanation of DocumentDB's versioning" | ||
| description: A comparison DocumentDB's long-term support, development, and release-candidate builds | ||
| date: 2026-10-01 | ||
| featured: true | ||
| author: DocumentDB team | ||
| category: documentdb-blog | ||
| tags: | ||
| - DocumentDB | ||
| - "1.0" | ||
| - Release | ||
| - Version | ||
| --- | ||
|
|
||
| DocumentDB is releasing v1.0-RC1 for testing. This is a release candidate preceding the full 1.0 release. | ||
| Following the full release, DocumentDB will split the main development branch that will continue with 1.1 and beyond from the LTS branch that will stay at 1.0. | ||
| This is to ensure there is a stable version of the platform for users who don't need the latest features. | ||
|
|
||
| This post will also clarify what support really means, describe how we will handle future minor version updates (1.1, 1.2, etc.), and explain when updates to the different tracks will happen. | ||
|
|
||
| ## Release candidates | ||
|
|
||
| Release candidates use the `-RC` suffix. For example, a release candidate for version 3 could be tagged `v3.0-RC1`, followed by a final release tag such as `v3.0-0`. | ||
| After the final release, `release/v3` becomes the supported branch for version 3, while `main` moves on to development for version 4. The previous `release/v2` branch remains supported during its grace period. | ||
|
|
||
| These experimental versions are not intended for long-term use, nor will they be supported past the full release. They are only for testing purposes, and if used should be used on a short-lived fresh instance. | ||
|
|
||
| ### Release candidate installation | ||
|
|
||
| For installation instructions, see our [README.md](https://github.com/documentdb/documentdb/blob/main/packaging/README.md#clean-host-installer) | ||
| or use the command below. | ||
|
|
||
| ```bash | ||
| curl -fsSLo documentdb-install.sh \ | ||
| https://documentdb.io/install.sh && | ||
| sh documentdb-install.sh --version v1.0-RC1 | ||
| ``` | ||
|
|
||
| If you find any problems with the RC, please [create an issue on GitHub](https://github.com/documentdb/documentdb/issues). | ||
|
|
||
| ## Definition of support | ||
|
|
||
| DocumentDB aims to publish one new major version each year. The major versions are on branches such as `release/v3`. | ||
| Security fixes will be backported to supported release branches, with new artifacts built until support ends. Other bug fixes will be backported case by case. | ||
| A major version will be supported until three months after the next major version is released. | ||
|
|
||
| Backports of security fixes will be added to the LTS version with a patch version bump. For example, a security fix could bump the long-term support branch to v3.0-1, but not v3.1-0. | ||
| The long-term support track will not get any minor updates, only patch updates. | ||
|
|
||
| ## The main development track | ||
|
|
||
| Major releases are time-based. Minor releases, however, will continue to be pushed out as development work completes. | ||
| The artifacts on the main development track will be built only on minor version releases. At that point the previous minor is deprecated and all development track users should update immediately. | ||
| In this way, all security and bug fixes will come as a user of the development track rolls forward with the latest minor updates. | ||
|
|
||
| ## Upgrade paths | ||
|
|
||
| DocumentDB will support direct in-place upgrades between consecutive long-term support major versions. | ||
| For example, if you are using v1.0-2, and v2.0-0 is released as part of a new major, there will be instructions for how to update to that next version before v1.0 falls out of support. | ||
|
|
||
| There is also a direct upgrade path from the current major release to the latest minor release of that same major. This will allow for a simple switch from long-term support to the latest builds. | ||
|
|
||
| Release candidates are different. Upgrades from release candidate versions will not be supported. Release candidates use the same extension version as the first full release for that major, so there is no reliable extension upgrade path from an RC to the final release. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please move this warning near the top: testing only, no ongoing RC1 maintenance, and no supported RC upgrades. Use a fresh instance each time. |
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.