Skip to content
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.

Sign up for GitHub

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

Update versioning policy for editor integration #12375

Merged
merged 2 commits into from
Jul 18, 2024
Merged

Update versioning policy for editor integration #12375

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dba2cd3
Update versioning policy for editor integration
dhruvmanila Jul 18, 2024
d4306f2
Apply suggestions from code review
dhruvmanila Jul 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion docs/versioning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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
Expand Down Expand Up @@ -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`, …
Loading