From 27abc9da986baf1ca42efb6c9cd1cbba219a60a6 Mon Sep 17 00:00:00 2001 From: Stijn de Gooijer Date: Thu, 6 Jun 2024 11:41:18 +0200 Subject: [PATCH] docs(python): Update versioning docs for 1.0.0 (#16757) --- .github/release-drafter-python.yml | 5 +++-- docs/development/versioning.md | 21 +++++++++++++++++++-- 2 files changed, 22 insertions(+), 4 deletions(-) diff --git a/.github/release-drafter-python.yml b/.github/release-drafter-python.yml index db6d54a61f27..9226c8616975 100644 --- a/.github/release-drafter-python.yml +++ b/.github/release-drafter-python.yml @@ -14,8 +14,9 @@ version-resolver: - breaking python patch: labels: - - fix - default: minor + - performance + - enhancement + default: patch categories: - title: 🏆 Highlights diff --git a/docs/development/versioning.md b/docs/development/versioning.md index 2ec5c623d265..e613199fe664 100644 --- a/docs/development/versioning.md +++ b/docs/development/versioning.md @@ -2,9 +2,11 @@ ## Version changes -Polars adheres to the [semantic versioning](https://semver.org/) specification. +Polars adheres to the [semantic versioning](https://semver.org/) specification: -As Polars has not released its `1.0.0` version yet, breaking releases lead to a minor version increase (e.g. from `0.18.15` to `0.19.0`), while all other releases increment the patch version (e.g. from `0.18.15` to `0.18.16`) +- Breaking changes lead to a **major** version increase (`1.0.0`, `2.0.0`, ...) +- New features and performance improvements lead to a **minor** version increase (`1.1.0`, `1.2.0`, ...) +- Other changes lead to a **patch** version increase (`1.0.1`, `1.0.2`, ...) ## Policy for breaking changes @@ -92,3 +94,18 @@ As breaking releases happen about once every six months, this allows six to twel **In some cases, we may decide to adjust the deprecation period.** If retaining the deprecated functionality blocks other improvements to Polars, we may shorten the deprecation period to a single breaking release. This will be mentioned in the warning message. If the deprecation affects many users, we may extend the deprecation period. + +## Release frequency + +Polars does not have a set release schedule. +We issue a new release whenever we feel like we have something new and valuable to offer to our users. +In practice, a new minor version is released about once every one or two weeks. + +### Breaking releases + +Over time, issues pop up that require a breaking change to address. +When enough issues have accumulated, we issue a breaking release. + +So far, breaking releases have happened about once every three to six months. +The rate and severity of breaking changes will continue to diminish as Polars grows more solid. +From this point on, we expect new major versions to be released about once every six months.