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

thedodd / ybc

A Yew component library based on the Bulma CSS framework.

Apache License 2.0

258 stars 37 forks source link

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

Open ppiotr3k opened 3 years ago

ppiotr3k commented 3 years ago

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 commented 3 years ago

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.