Improve "infrastructure" crate wide #88
Conversation
|
Please do not merge until #45 is done so @Ericson2314 does not have to rebase on top of this. |
tcharding
force-pushed
the
03-03-infra
branch
3 times, most recently
from
8560399
to
8096aff
Compare
tcharding
force-pushed
the
03-03-infra
branch
2 times, most recently
from
e203ed6
to
04c59a8
Compare
|
Checked over the whole patch series, made minor improvements removing an unrelated change from one patch. Added an additional patch to do a clippy fix. |
| git diff-index --check --cached $against -- || exit 1 | ||
|
|
||
| # Check that code lints cleanly. | ||
| cargo clippy --all-features -- -D warnings || exit 1 |
There was a problem hiding this comment.
This is a cool addition. Confirmed working after opting in to hooks.
There was a problem hiding this comment.
Yeah the git hooks are super useful, it often pains me to wait each time I commit so I tend to use -n a bit which ignores the hooks i.e., git commit -a -m 'WIP: dirty commit' -n
|
I guess the docsrs thing should be changed now to use |
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
force-pushed
the
03-03-infra
branch
3 times, most recently
from
b1a4026
to
313b1e2
Compare
Add whitespace, and use second layer markdown header for subheading.
tcharding
force-pushed
the
03-03-infra
branch
2 times, most recently
from
28deec8
to
e60d87c
Compare
As we are doing throughout the rust-bitcoin ecosystem; bump the MSRV to Rust 1.48.0
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.
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)`.
Currently we are setting a bunch of lint config options to their default values, this is redundant.
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
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)
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.
|
ooo TIL about |
|
LGMT! |
lolz we merged that command into various readmes so long ago :) |
Improve various things around the crate (infrastructure for want of a better word)
Please note: Includes bump of MSRV to 1.48.0 because arrayvec was failing with 1.41 after improving CI.
EDIT: Oooooh, now I get it, arrayvec feature breaks the MSRV, regardless of if its 1.41 or 1.48 - I forgot that. I"m totally sick of rebasing this so I'm leaving the MSRV bump in there.
Patch 7
ef35d89 Enable build of docs with doc_auto_cfgfixes #75