Skip to content

Add API subcommand #43

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
tcharding merged 3 commits into from
Dec 17, 2025
Merged

Add API subcommand #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dfcf054
cargo-rbmt: refactor get_packages to return tuples
nyonson Dec 16, 2025
a105adc
cargo-rbmt: add API command
nyonson Dec 16, 2025
d0abec0
cargo-rbmt: extend api command with baseline arg
nyonson Dec 16, 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
29 changes: 29 additions & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions cargo-rbmt/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@ clap = { version = "4", features = ["derive"] }
serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"
toml = "0.8"
public-api = "0.47"
26 changes: 20 additions & 6 deletions cargo-rbmt/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,10 +115,6 @@ To ensure your package works with the full range of declared dependency versions

The `lock` command generates and maintains these files for you. You can then use `--lock-file` with any command to test against either version set.

### Usage

**Generate/update lock files**

```bash
cargo rbmt lock
```
Expand All @@ -127,8 +123,6 @@ cargo rbmt lock
2. Generate `Cargo-minimal.lock` with minimal versions across the entire dependency tree.
3. Update `Cargo-recent.lock` with conservatively updated dependencies.

**Use a specific lock file**

```bash
# Test with minimal versions.
cargo rbmt --lock-file minimal test stable
Expand All @@ -143,6 +137,26 @@ cargo rbmt --lock-file minimal docs

When you specify `--lock-file`, the tool copies that lock file to `Cargo.lock` before running the command. This allows you to test your code against different dependency version constraints.

## API Checking

The `api` command helps maintain API stability by generating public API snapshots and checking for breaking changes. It uses the [public-api](https://github.com/Enselic/cargo-public-api) crate to analyze a crate's public interface.

```bash
cargo rbmt api
```

1. Generates API snapshots for each feature configuration (no-features, alloc-only, all-features).
2. Validates that features are additive (enabling features only adds to the API, never removes).
3. Checks for uncommitted changes to API files.

The generated API files are stored in `api/<package-name>/`.

```bash
cargo rbmt api --baseline v0.1.0
```

Compares the current API against a baseline git reference (tag, branch, or commit) to detect breaking changes.

## Workspace Integration

`cargo-rbmt` can simply be installed globally on a system or added as a dev-dependency to a package.
Expand Down
Loading