Add draft of proposed new library API. #600
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As
cargo-semver-checks
is getting adopted by more and more projects, we're seeing more and more cases where our current APIs and config flags give users insufficient control over various edge cases that happen in the real world.To address such edge cases, we'll need to expose a richer API in our lib target, which can then be used both as a dependency of other tools (e.g.
release-plz
) and directly via the CLI. I'm adding a draft for such a new API, and I'm looking for feedback!Here are the issues we've seen so far, lightly grouped:
cargo semver-check
on diesel #108RUSTFLAGS
env var sets-Dwarnings
#589--workspace
runs #163Cargo.toml
version is already published on the registry #356publish = false
crates in a workspace #424This PR contains the code for discussion #599.
If you have general feedback about the idea, please post it in the discussion: #599
If you have feedback related to specific lines of code, please post it attached to those lines in this PR.