ybc icon indicating copy to clipboard operation
ybc copied to clipboard

Add `cargo test` in CI workflow, fix failing Rustdoc examples

Open ppiotr3k opened this issue 4 years ago • 1 comments

Current CI workflow does not perform any testing on the codebase - which in fact does not include any unit or integration tests. The lack of testing lowers the confidence users might have in the library, and makes upgrading dependencies complex as impact of such upgrades (ex: breaking changes) can't be identified easily.

This PR aims to try improving this, by having cargo test in the CI workflow, and fixing existing Rustdoc examples that are currently failing after such addition.

ppiotr3k avatar Jun 13 '21 00:06 ppiotr3k

Adding cargo test to CI workflow and fixing existing Rustdoc examples have been performed in two commits not only as best practices to ease review, but also to highlight why fixing the Rustdoc examples was needed.

However, as workflow execution following PR requires approval, please use ppiotr3k/ybc in order to see the evolution of the CI status for each of those commits.

ppiotr3k avatar Jun 13 '21 00:06 ppiotr3k