public-api
List and diff the public API of Rust library crates by analyzing rustdoc JSON output files from rustdoc +nightly
.
Usage
… as a Rust library
See docs.rs for library documentation and example code.
… as a CLI
Use cargo public-api
for CLI use cases.
… as a CI Check
With a regular cargo test
that you run in CI you will be able to
- prevent accidental changes to your public API
- review the public API diff of deliberate changes
First add the latest versions of the recommended libraries to your [dev-dependencies]
:
Then add the following test to your project. As the author of the below test code, I hereby associate it with CC0 and to the extent possible under law waive all copyright and related or neighboring rights to it:
Before you run the test the first time you need to bless the current public API:
UPDATE_EXPECT=1
This creates a tests/public-api.txt
file in your project that you git add
together with your other project files. Whenever you change the public API, you need to bless it again with the above command. If you forget to bless, the test will fail, together with instructions on how to bless.
Changelog
See CHANGELOG.md.
Maintainers
See here.