From 4dff3550b3ca51f25bb70e996c50eacf088cbc64 Mon Sep 17 00:00:00 2001 From: steve-chavez Date: Fri, 24 Oct 2025 17:22:23 -0500 Subject: [PATCH] docs: new two-part versioning in releases section Also add entry to the changelog --- CHANGELOG.md | 1 + docs/index.rst | 30 +++++++++++++++++++++++++++--- 2 files changed, 28 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f76cfca63..69132f0e7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,6 +23,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). ### Changed - Drop support for PostgreSQL EOL version 12 by @wolfgangwalther in #3865 +- From now on PostgREST will follow a `MAJOR.PATCH` two-part versioning. Only even-numbered MAJOR versions will be released, reserving odd-numbered MAJOR versions for development. - Replaced `jwt-cache-max-lifetime` config with `jwt-cache-max-entries` by @mkleczek in #4084 - `log-query` config now takes a boolean instead of a string value by @steve-chavez in #3934 diff --git a/docs/index.rst b/docs/index.rst index 3761ead2a..17c44c226 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -106,10 +106,17 @@ Getting Support The project has a friendly and growing community. For discussions, use the Github `discussions page `_. You can also report or search for bugs/features on the Github `issues `_ page. -Release Notes -------------- +Releases +-------- -The release notes are published on `PostgREST's GitHub release page `_. +PostgREST follows ``MAJOR.PATCH`` two-part versioning: + +- ``MAJOR``: feature release, may deprecate or remove things. +- ``PATCH``: fix/security release only; no features, no behavior changes. + +Starting from ``v14.0``, only even-numbered MAJOR versions will be released, reserving odd-numbered MAJOR versions for development. + +All the releases are published on `PostgREST's GitHub release page `_. Tutorials --------- @@ -259,3 +266,20 @@ Contributing ------------ Please see the `Contributing guidelines `_ in the main PostgREST repository. + +.. raw:: html + +