Skip to content

Updated compatibility policy based on changes to repo structure #3695

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
merged 2 commits into from
Oct 27, 2025
Merged

Updated compatibility policy based on changes to repo structure #3695

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4116b44
Updated compatibility policy based on changes to repo structure
UebelAndre Oct 22, 2025
8d58304
Merge branch 'main' into policy
UebelAndre Oct 22, 2025
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
27 changes: 17 additions & 10 deletions COMPATIBILITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,24 +66,31 @@ Process for moving a best effort platform to a supported platform is consensus-b

## What are the stable APIs of `rules_rust`?

`//rust:defs.bzl` is subject to the backwards compatibility policy. That means
that anything directly accessible from this file is considered stable.
`//**/private/...` (any `private` directory and it's contents) is not subject to the backwards
compatibility policy. All starlark symbols and targets is an implementation detail.

`//rust/private/…` is not subject to the backwards compatibility policy. Content
of this package is an implementation detail.
`//rust` is subject to the backwards compatibility policy. That means that anything directly
accessible from this file is considered stable.

`//cargo/...` is subject to the backwards compatibility policy.
`//cargo` is subject to the backwards compatibility policy.

`//util`, `//tools`, `//test`, `//examples`, `//extensions`, `//ffi`, `//nix` and any packages
not mentioned by this document are by default not subject to the backwards compatibility
policy.
`//crate_universe`, `//examples`, `//extensions`, `//ffi`, `//nix`, `//test`, `//tools`, `//util`
and any packages not mentioned by this document are by default not subject to the backwards
compatibility policy.

Experimental build settings are not subject to the backward compatibility
policy. They should be added to `//rust:experimental.bzl`.
policy.

Incompatible build settings are subject to the backward compatibility policy,
meaning the behavior of the flag cannot change in a backwards incompatible way.
They should be added to `//rust:incompatible.bzl`.

Experimental and incompatible flags should be added to `settings.bzl` files based on the scope
of the change.

| scope | file to update |
| ------------- | ------------------------------- |
| `//rust/...` | `//rust/settings:settings.bzl` |
| `//cargo/...` | `//cargo/settings:settings.bzl` |

Bug fixes are not a breaking change by default. We'll use Common Sense (and we
will pull in more maintainers and the community to discuss) if we see a certain
Expand Down