rust-bitcoin / rust-bitcoin / 9809709501

83%

push

github

Merge rust-bitcoin/rust-bitcoin#2946: ci: `cargo-semver-checks`

<a class=hub.com/rust-bitcoin/rust-bitcoin/commit/<a class="double-link" href="https://git"><a class=hub.com/rust-bitcoin/rust-bitcoin/commit/eeae225cfca149d669b0ba7e623faca970e82a65">eeae225cf<a href="https://github.com/rust-bitcoin/rust-bitcoin/commit/57f608fced29f6b5d9b1618a3e0f79844a4c4670"> ci: add cargo-semver-checks (Jose Storopoli)
<a class="double-link" href="https://github.com/rust-bitcoin/rust-bitcoin/commit/d9567b097fa5fe9d17e1bcf7832d3880501a314a">d9567b097</a> ci: remove check-api (Jose Storopoli)

Pull request description:

  - Removes `check-api` (`cargo-public-api`)
  - Adds `cargo-semver-checks`

  ## Note to Reviewers

  There is a new script `contrib/check-semver.sh` that checks for semver breaks against `master`.
  If it detects a breaking change it will create the `.semver-break` file.
  If this file exists then we will add an `API break` label and a big comment to the PR saying:

  > 🚨 API BREAKING CHANGE DETECTED

  It reproduces the current behavior of `cargo-public-api`:

  - `bitcoin`:
    - `all-features`
    - `no-default-features`
  - `base58ck`:
    - `all-features`
    - `no-default-features`
  - `bitcoin_hashes`:
    - `no-default-features`
    - `features alloc`
  - `bitcoin-units`:
    - `no-default-features`
    - `features alloc`
  - `bitcoin-io`:
    - `no-default-features`
    - `features alloc`

  Closes #1875.
  Supersedes #2912.

  ## Context

  Our current test to check API breaks using `cargo public-api` is not "automated" per se.
  It needs contributors to keep tabs on text files with function signatures and other things and forces reviewers to be the _de facto_ API break detector tool.

  The idea is to use the well-acclaimed and maintained `cargo semver-checks` that will do this automatically in CI.

ACKs for top commit:
  Kixunil:
    ACK eeae225cfca149d669b0ba7e623faca970e82a65
  tcharding:
    ACK eeae225cfca149d669b0ba7e623faca970e82a65

Tree-SHA512: a77d64b4c98e38602ffc4350e82903933ae

19504 of 23515 relevant lines covered (82.94%)

15617.45 hits per line