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

Including testing tutorial notebooks in PR unit CI workflow #127

Merged
merged 30 commits into from
Apr 2, 2024

Conversation

chrisjonesBSU
Copy link
Member

This PR adds nbmake to environment-dev.yml and adds an action for testing the tutorial notebooks anytime a PR is made.

The addition of this workflow and use of nbmake seems to be working as intended, but some of the notebooks have errors. I'll work on fixing those in this same PR.

@chrisjonesBSU chrisjonesBSU linked an issue Mar 28, 2024 that may be closed by this pull request
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@chrisjonesBSU
Copy link
Member Author

Ok, I added MacOS to the os matrix now.

Also, I made a separate jobs for testing the tutorials. I don't think we need to test the tutorials on every os + python version combo. Also, it should be set up so that the tutorial test has to be trigged manually with a comment in the PR. My thinking is that we can run that check once a PR is nearly finished, rather than having it run after every commit.

Copy link

codecov bot commented Mar 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.40%. Comparing base (9f0cda5) to head (9d5a5c7).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #127   +/-   ##
=======================================
  Coverage   94.40%   94.40%           
=======================================
  Files          25       25           
  Lines        1840     1840           
=======================================
  Hits         1737     1737           
  Misses        103      103           

@chrisjonesBSU
Copy link
Member Author

run-test-tutorials

@chrisjonesBSU
Copy link
Member Author

run-test-tutorials

1 similar comment
@chrisjonesBSU
Copy link
Member Author

run-test-tutorials

@chrisjonesBSU
Copy link
Member Author

/testtutorials

@chrisjonesBSU
Copy link
Member Author

Hmm..I can't figure out how to trigger the pytest / test-tutorials check with a comment.

@chrisjonesBSU
Copy link
Member Author

This discussion and this link to the documentation seem like good places to look.

@chrisjonesBSU
Copy link
Member Author

/testtutorials

@marjanalbooyeh
Copy link
Collaborator

/testtutorials

@marjanalbooyeh
Copy link
Collaborator

/testtutorials

@marjanalbooyeh
Copy link
Collaborator

/testtutorials

@marjanalbooyeh
Copy link
Collaborator

testtutorials

@marjanalbooyeh
Copy link
Collaborator

/testtutorials

@chrisjonesBSU
Copy link
Member Author

Ok, we're merging this as is for now. After talking with @marjanalbooyeh we are going to get a workflow set up to run test on notebooks locally or on clusters.

@chrisjonesBSU chrisjonesBSU merged commit 7f85dc3 into cmelab:main Apr 2, 2024
8 checks passed
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.

Tutorial in tests
2 participants