Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve "infrastructure" crate wide #88

Merged
merged 9 commits into from
Apr 3, 2023
Merged

Improve "infrastructure" crate wide #88

merged 9 commits into from
Apr 3, 2023

Commits on Apr 3, 2023

  1. Use SPDX license ID 

    Move the license to a separate file and use an SPDX identifier in the
source file. This is more terse but with the same legal coverage.

Keep Clark's name as author but add "the rust-bitcoin developers" also
for attribution and accountability.
    @tcharding
    tcharding committed Apr 3, 2023
    Configuration menu
    Copy the full SHA
    ded35fe View commit details
    Browse the repository at this point in the history

  2. Do trivial cleanup to readme 

    Add whitespace, and use second layer markdown header for subheading.
    @tcharding
    tcharding committed Apr 3, 2023
    Configuration menu
    Copy the full SHA
    5962169 View commit details
    Browse the repository at this point in the history

  3. Bump MSRV to Rust 1.48.0 

    As we are doing throughout the rust-bitcoin ecosystem; bump the MSRV to
Rust 1.48.0
    @tcharding
    tcharding committed Apr 3, 2023
    Configuration menu
    Copy the full SHA
    f5cd60e View commit details
    Browse the repository at this point in the history

  4. Remove allow(unknown_lints) 

    We do not have any unknown lints, I'm not even sure its possible to get
them now that we have the MSRV in the clippy config file.
    @tcharding
    tcharding committed Apr 3, 2023
    Configuration menu
    Copy the full SHA
    7fb1755 View commit details
    Browse the repository at this point in the history

  5. Remove allow(bare_trait_objects) 

    Clippy emits:

 warning: trait objects without an explicit `dyn` are deprecated

We are currently configuring the linter to allow this but it is not
necessary.

Use `dyn` as suggested by the linter and remove
`allow(bare_trait_objects)`.
    @tcharding
    tcharding committed Apr 3, 2023
    Configuration menu
    Copy the full SHA
    81b8201 View commit details
    Browse the repository at this point in the history

  6. Remove default lint config options 

    Currently we are setting a bunch of lint config options to their
default values, this is redundant.
    @tcharding
    tcharding committed Apr 3, 2023
    Configuration menu
    Copy the full SHA
    a37819b View commit details
    Browse the repository at this point in the history

  7. Enable build of docs with doc_auto_cfg 

    Use the recently learned about `doc_auto_cfg` feature and enable it
using a custom `docsrs` compiler conditional configuration option.

Fix and improve the rustdocs while we are at it.

Add docs build to CI script but do not enable it in the github actions
yet.

Fix: rust-bitcoin#75
    @tcharding
    tcharding committed Apr 3, 2023
    Configuration menu
    Copy the full SHA
    ef35d89 View commit details
    Browse the repository at this point in the history

  8. Improve CI pipeline 

    Improve the CI pipeline by doing:

- Run docs build with stable/nightly as required
- Run 32 bit tests (default features with a 32 bit target)
- Run cross tests (default features with a s390x target)
    @tcharding
    tcharding committed Apr 3, 2023
    Configuration menu
    Copy the full SHA
    d4191cc View commit details
    Browse the repository at this point in the history

  9. Add githooks directory 

    Add a `githooks` directory and a `pre-commit` hook. Add a section to the
readme instructing devs how to configure git to take advantage of the
githooks.
    @tcharding
    tcharding committed Apr 3, 2023
    Configuration menu
    Copy the full SHA
    c691a83 View commit details
    Browse the repository at this point in the history