cargo-semver-checks
cargo-semver-checks-action
Our great sponsors
cargo-semver-checks | cargo-semver-checks-action | |
---|---|---|
18 | 5 | |
901 | 53 | |
- | - | |
9.3 | 6.6 | |
7 days ago | 5 days ago | |
Rust | TypeScript | |
Apache License 2.0 | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
cargo-semver-checks
-
Semver violations are common, better tooling is the answer
If you'd like to dig deeper, here are some links:
- cargo-semver-checks: https://github.com/obi1kenobi/cargo-semver-checks
- Trustfall query engine, which powers cargo-semver-checks: https://github.com/obi1kenobi/trustfall
- Trustfall playground, where you can query Rust library APIs in your browser -- for example, "which structs in `itertools` are importable by more than one path": https://play.predr.ag/rustdoc#?f=2&q=*3-Structs-importable-f...
- 10min conference talk on Trustfall: https://www.hytradboi.com/2022/how-to-query-almost-everythin...
I'm also giving a talk at P99 CONF in a few months about how Trustfall's new optimizations API made cargo-semver-checks over 2300x faster: https://twitter.com/PredragGruevski/status/16893002495908003...
- Cargo-semver-checks: Scan your Rust crate for semver violations
- cargo-semver-checks v0.20 and Trustfall v0.4 released — semver-check up to 2354x faster
-
err-as-you-go crate - anyhow meets thiserror
I strongly recommend that anybody creating new error types for public APIs read Study of std::io::Error by u/matklad to see some ways that error types can [need to] be future-proofed. I don't know if cargo-semver-checks can catch these issues when they're generated by a macro, but it'd be something people using this crate should carefully look into.
-
Re-exporting an enum with a type alias is breaking, but not major
cargo-semver-checks will implement a check for cases like this, and many other hazards like it. The check will be major, or minor, or just a hazard — whatever the overall community decides is right.
-
cargo-semver-checks v0.18.0: rustdoc caching, new lints & more
Full release notes: https://github.com/obi1kenobi/cargo-semver-checks/releases/tag/v0.18.0
-
cargo-semver-checks v0.17 is out: correct re-export handling
Release notes, TL;DR: Rust 1.65+ only, no more false positives due to moved+re-exported items.
- Semver implications of `#[non_exhaustive]` behavior on tuple/unit enum variants · Issue #304 · obi1kenobi/cargo-semver-checks
cargo-semver-checks-action
- cargo-semver-checks v0.20 and Trustfall v0.4 released — semver-check up to 2354x faster
-
cargo-semver-checks v0.18.0: rustdoc caching, new lints & more
Short answer: it doesn't, it's on purpose, and our upcoming v2 action will offer the option: https://github.com/obi1kenobi/cargo-semver-checks-action/pull/21
-
cargo-semver-checks 0.12.0 is released w/ stability guarantee for stable and beta Rust
The GitHub Action has been updated accordingly and will no longer break on every new rustdoc format change in nightly.
-
Toward fearless `cargo update`
Or use as a GitHub Action (used in .github/workflows/ci.yml in its own repo): yaml - name: Check semver uses: obi1kenobi/cargo-semver-checks-action@v1
What are some alternatives?
prql-query - Query and transform data with PRQL
trustfall - A query engine for any combination of data sources. Query your files and APIs as if they were databases!
argfile - Load additional CLI args from file
rust-semverver - Automatic checking for semantic versioning in library crates
octosql-plugin-postgres
Elm - Compiler for Elm, a functional language for reliable webapps.
go-sqlite3-stdlib - A standard library for mattn/go-sqlite3 including best-effort date parsing, url parsing, math/string functions, and stats aggregation functions
tokio - A runtime for writing reliable asynchronous applications with Rust. Provides I/O, networking, scheduling, timers, ...
ddl-diff - Generates SQL migrations by parsing and diffing DDL
docs.rs - crates.io documentation generator
octosql-plugin-random_data - OctoSQL plugin serving random data
semver - Semantic Versioning Specification