From 7953f6aa79f7546f3c2ff4f9e80d7694c13d62c6 Mon Sep 17 00:00:00 2001 From: Dhruv Manilawala Date: Thu, 18 Jul 2024 20:47:36 +0530 Subject: [PATCH] Update versioning policy for editor integration (#12375) ## Summary Following the stabilization of the Ruff language server, we need to update our versioning policy to account for any changes in it. This could be server settings, capability, etc. This PR also adds a new section for the VS Code extension which is adopted from [Biome's versioning policy](https://biomejs.dev/internals/versioning/#visual-studio-code-extension) for the same. --------- Co-authored-by: Zanie Blue --- docs/versioning.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/docs/versioning.md b/docs/versioning.md index 31de1e1b2e546..3546d0a696cc4 100644 --- a/docs/versioning.md +++ b/docs/versioning.md @@ -20,8 +20,11 @@ Ruff uses a custom versioning scheme that uses the **minor** version number for - Stable rules are added to the default set - Stable rules are removed from the default set - A safe fix for a rule is promoted to stable -- Formatter: +- Formatter: - The stable style changed +- Language server: + - An existing capability is removed + - A deprecated server setting is removed **Patch** version increases will occur when: @@ -40,6 +43,10 @@ Ruff uses a custom versioning scheme that uses the **minor** version number for - Formatter: - The stable style changed to prevent invalid syntax, changes to the program's semantics, or removal of comments - The preview style changed +- Language server: + - Support for a new capability is added + - A new server setting is added + - A server setting is deprecated ## Preview mode @@ -70,3 +77,13 @@ Fixes have three applicability levels: - **Safe**: Can be applied automatically. Fixes for rules may be introduced at a lower applicability, then promoted to a higher applicability. Reducing the applicability of a fix is not a breaking change. The applicability of a given fix may change when the preview mode is enabled. + +## Visual Studio Code Extension + +Visual Studio Code [doesn't support pre-release +tags](https://code.visualstudio.com/api/working-with-extensions/publishing-extension#prerelease-extensions) +for extensions. Consequently, Ruff uses the following scheme to distinguish between stable and +preview releases: + +Stable releases use even numbers in minor version component: `2024.30.0`, `2024.32.0`, `2024.34.0`, … +Preview releases use odd numbers in minor version component: `2024.31.0`, `2024.33.0`, `2024.35.0`, …