Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Check if all examples run successfully #1068

Merged
merged 4 commits into from
Nov 24, 2022
Merged

Check if all examples run successfully #1068

merged 4 commits into from
Nov 24, 2022

Conversation

IndrajeetPatil
Copy link
Collaborator

@IndrajeetPatil IndrajeetPatil commented Nov 24, 2022

\donttest examples are run in an additional check by BDR, and probably \dontrun examples are also run in some other checks.

Therefore, making sure all examples run successfully (or are never run if they are just for illustrative purposes) is a good preventive practice in general.

This PR does that and also adds a workflow to catch such failures in the future.

@codecov-commenter
Copy link

codecov-commenter commented Nov 24, 2022

Codecov Report

Merging #1068 (467d2f4) into main (55e8559) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1068   +/-   ##
=======================================
  Coverage   91.06%   91.06%           
=======================================
  Files          46       46           
  Lines        2685     2685           
=======================================
  Hits         2445     2445           
  Misses        240      240           
Impacted Files Coverage Δ
R/parse.R 87.95% <ø> (ø)
R/rules-line-breaks.R 100.00% <ø> (ø)
R/set-assert-args.R 90.47% <ø> (ø)
R/transform-files.R 97.41% <ø> (ø)
R/ui-styling.R 100.00% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@IndrajeetPatil IndrajeetPatil changed the title Check if all examples run successfully WIP: Check if all examples run successfully Nov 24, 2022
@IndrajeetPatil IndrajeetPatil changed the title WIP: Check if all examples run successfully Check if all examples run successfully Nov 24, 2022
@IndrajeetPatil IndrajeetPatil marked this pull request as ready for review November 24, 2022 08:36
Copy link
Collaborator

@lorenzwalthert lorenzwalthert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure why not. Never heard of these additional checks. Is there documentation for those?

@IndrajeetPatil
Copy link
Collaborator Author

Yes, all additional checks can be found here. There is README.txt in each folder that describes the details of that check.

@github-actions
Copy link
Contributor

This is how benchmark results would change (along with a 95% confidence interval in relative change) if 55e8559 is merged into main:

  •   :ballot_box_with_check:cache_applying: 37.2ms -> 36.5ms [-4.14%, +0.73%]
  •   :ballot_box_with_check:cache_recording: 1.17s -> 1.17s [-1.18%, +0.42%]
  •   :ballot_box_with_check:without_cache: 2.94s -> 2.95s [-0.32%, +0.92%]

Further explanation regarding interpretation and methodology can be found in the documentation.

@IndrajeetPatil IndrajeetPatil merged commit ee8eb81 into main Nov 24, 2022
@IndrajeetPatil IndrajeetPatil deleted the check_examples branch November 24, 2022 09:00
IndrajeetPatil added a commit that referenced this pull request Nov 25, 2022
Follow up on #1068, where I introduced these deviations.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants