rust-bitcoin / rust-bitcoin / 9140576113

83%

push

github

Merge rust-bitcoin/rust-bitcoin#2713: Check for changes to the public API

<a class=hub.com/rust-bitcoin/rust-bitcoin/commit/76331aeee3519904696c801c236d4737487e657c">76331aeee<a href="https://github.com/rust-bitcoin/rust-bitcoin/commit/13569b86a126a2527f7c8d2eb092dc29741c3e59"> Add a just cmd to check for API changes (Tobin C. Harding)
<a class="double-link" href="https://github.com/rust-bitcoin/rust-bitcoin/commit/b222f40f99a98064a5ffdc1bfc283c62523678ad">b222f40f9</a><a href="https://github.com/rust-bitcoin/rust-bitcoin/commit/13569b86a126a2527f7c8d2eb092dc29741c3e59"> CI: Add job to check for API changes (Tobin C. Harding)
</a><a class="double-link" href="https://github.com/rust-bitcoin/rust-bitcoin/commit/9e7cd97c25fd662262a6717196b28426996cf7cc">9e7cd97c2</a> Add a script to check the public API (Tobin C. Harding)

Pull request description:

  This PR is #1880 re-opened.

  Add a script that checks the public API of `hashes` and `bitcoin`. Document how to use it during development. Call it in CI. Do not add it to githooks because the githooks because its expected to be run per PR not per commit.

  Includes a `just` command to run the script: `just check-api`

  ### Implied workflow change

  This PR imposes workflow changes.

  Explicitly: all PRs that change the public API of `bitcoin`, `base58`, `hashes`, `io`, or `units` must contain changes to the api text files.

  Suggestion: We add the patch updating api text files as a separate patch at the end of each PR so we can haggle over it separately from the actual code changes.

  Fix: #1875

ACKs for top commit:
  apoelstra:
    ACK 76331aeee3519904696c801c236d4737487e657c normally would complain about the whitespace but I would like to ACK/merge this quickly since most other PR that gets merged will force it to be rebased. also will one-ACK merge as "no NACKs or comments from maintainers in 2 weeks"

Tree-SHA512: 67b20e2ceaa620003c93f2d16f957b7901b

19303 of 23168 relevant lines covered (83.32%)

16791.83 hits per line