Skip to content

Deprecate breaking change detection #477

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

Merged
doriable merged 1 commit into from
Nov 6, 2025
Merged

Deprecate breaking change detection #477

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 1 addition & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ documentation and diagnostic hovers, and integrations with [Buf][buf] commands.

- **Code navigation** - Go-to definition and documentation insets for `.proto` symbols.
- **Syntax highlighting** - Protobuf specific color and styling of code.
- **Code editing** - Formatting via `buf format` and annotations and hovers based on `buf lint`
and `buf breaking`.
- **Code editing** - Formatting via `buf format` and annotations and hovers based on `buf lint`.
- **Documentation hovers** - Documentation for definitions when hovering a reference.
- **Buf command support** - Execution of `buf` CLI commands via the [Command Palette][command-palette].

Expand Down Expand Up @@ -71,17 +70,6 @@ Enable debug logs in output channels.
Default: `text`
Buf Language Server log format.

### buf.checks.breaking.againstStrategy

Default: `git`
The strategy to use when checking breaking changes against a specific reference.

### buf.checks.breaking.againstGitRef

Default: `refs/remotes/origin/HEAD`
The Git reference to check breaking changes against. This is only compatible when `buf.checks.breaking.againstStrategy`
is set to `git`, otherwise it is ignored.

## Commands

This extension contributes the following commands to the [Command Palette][command-palette].
Expand Down
6 changes: 4 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,12 +207,14 @@
"git"
],
"default": "git",
"description": "The strategy to use when checking breaking changes against a specific reference."
"description": "The strategy to use when checking breaking changes against a specific reference.",
"deprecationMessage": "Deprecated: breaking change detection is no longer supported in the LSP."
},
"buf.checks.breaking.againstGitRef": {
"type": "string",
"default": "refs/remotes/origin/HEAD",
"description": "The Git reference to check breaking changes against."
"description": "The Git reference to check breaking changes against.",
"deprecationMessage": "Deprecated: breaking change detection is no longer supported in the LSP."
}
}
},
Expand Down