Add cargo test in CI workflow, fix failing Rustdoc examples
#21
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Current examples for `ModalCloser` fail `cargo test` as they require some not provided yet required boilerplate code, plus do include a minor mistake following previous changes in YBC. This fixes `ModalCloser` examples to pass `cargo test`, while preserving the existing code/snippets presentation choices.
|
Adding However, as workflow execution following PR requires approval, please use |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 testin the CI workflow, and fixing existing Rustdoc examples that are currently failing after such addition.