diff options
author | Andrew Godwin | 2022-11-27 14:04:43 -0700 |
---|---|---|
committer | Andrew Godwin | 2022-11-27 14:04:43 -0700 |
commit | 0a5e05e2701c3187036f520104056ed95f7e8516 (patch) | |
tree | 99aba4d67cd72b87615737c19501281a59b17807 /docs/releases/index.rst | |
parent | 3217569df583829d776bcbaf77b80696d3527005 (diff) | |
download | takahe-0a5e05e2701c3187036f520104056ed95f7e8516.tar.gz takahe-0a5e05e2701c3187036f520104056ed95f7e8516.tar.bz2 takahe-0a5e05e2701c3187036f520104056ed95f7e8516.zip |
Prepping release docs
Diffstat (limited to 'docs/releases/index.rst')
-rw-r--r-- | docs/releases/index.rst | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/releases/index.rst b/docs/releases/index.rst new file mode 100644 index 0000000..b47361d --- /dev/null +++ b/docs/releases/index.rst @@ -0,0 +1,34 @@ +Releases +======== + +Versions +-------- + +.. toctree:: + :maxdepth: 1 + + 0.4 + 0.3 + + +Versioning Policy +----------------- + +Takahē approximately follows Semantic Versioning, with some specific +clarifications about what each upgrade means to you as a server administrator: + +* **Patch** releases are bugfixes or small feature improvements that do not + require a database migration. It is safe to run patch versions from the same + minor series at the same time during an upgrade. + +* **Minor** releases are larger feature improvements or other changes that + require a database migration. Unless otherwise noted, these will be + backwards-compatible migrations that can be applied to the database while the + previous version is still running, before the running code is updated. + +* **Major** releases may have major breaking changes that require significant + upgrade time to perform, and will likely incur downtime. The exception will + be our 1.0 release, which will be treated as a minor release, continuing + on from the 0.x release series. + +All release and upgrade notes can be found here, in the documentation. |