Add a simple script that allows one to query the current API. Done by
parsing the API text files and grepping for things.
This is useful as a dev tool as we try to stabalize the leaf crates.
Add a script to generate API files using `cargo public-api` for the
crates that we are trying to stabalise (the so called 'leaf crates').
- hashes
- io
- primitives
- units
We already ran the script and committed the files last patch. The fact
that this patch does not include any changes to the `api/` directory and
that CI passes is enough to convince us that last patch was valid.
Add a CI job that runs the script and checks there are no changes to
the committed text files thereby proving no API changes are made in a
PR without explicitly modifying the API text files.
Add documentation to `CONTRIBUTING.md` on what is expected of devs.
In order to show warnings for unused imports etc. in doc examples an
extra test has been added to the justfile for `just lint` and the doc
test in `just sane` has been removed since it calls `just lint`.
d07550d86d just: add just docsrs (Jose Storopoli)
Pull request description:
Adds `just docsrs` which takes [variadic arguments](https://just.systems/man/en/chapter_41.html?highlight=zero%20or#recipe-parameters) (zero or more after the command).
Kixunil this allows for `just docsrs` and `just docsrs --open`.
Closes#2965.
Using the command from `rust-bitcoin-maintainer-tools`: 3494ceec52/ci/run_task.sh (L277)
ACKs for top commit:
jamillambert:
ACK d07550d86d
Kixunil:
ACK d07550d86d
apoelstra:
ACK d07550d86d
Tree-SHA512: dfc8a91bf9d572cb0cb460102f051aabe026fde2852ef2c82e962f0c60d8532628aa15bb99590a6140871d5539cdd9e5c6f80d0684fc128031f1c930e66e99ff
We already have a `just` command to check the formatting, add one to run
the formatter. Use the more terse `just fmt` although the difference
from `just format` is not super obvious it is documented in the default
output of `just`.
The nightly pinning is used by a bunch of different tools outside of
github actions, move the config file to the crate root.
Update the path in the justfile.
Done in preparation for fixing the git pre-commit hook.
If our custom dev scripts get a `just` command it makes them more
discoverable for new contributors.
Add a command to run the `update-lock-files.sh` script.
Tobin C. Harding
Jamil Lambert, PhD
Ryan Breen
merge-script
Jose Storopoli