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

ci: Skip doctest for 'Minimum supported dependencies' workflow #1589

Merged
merged 3 commits into from
Sep 5, 2021

Conversation

matthewfeickert
Copy link
Member

@matthewfeickert matthewfeickert commented Sep 4, 2021

Description

Run pytest explicitly over the tests/ directory only to avoid in the 'Minimum supported dependencies' workflow to avoid running doctest on the docstring examples. The latest version of the JAX docsting examples have some print failures that are incompatible with the older versions of JAX, even thought the API tests pass.

Checklist Before Requesting Reviewer

  • Tests are passing
  • "WIP" removed from the title of the pull request
  • Selected an Assignee for the PR to be responsible for the log summary

Before Merging

For the PR Assignees:

  • Summarize commit messages into a comprehensive review of the PR
* Run pytest explicitly over the tests/ directory only to avoid in the 'Minimum supported dependencies' workflow to avoid running doctest on the docstring examples
   - The docstring examples use the latest dependencies which might have different text output than older releases. So focus only on the API tests

@matthewfeickert matthewfeickert added the CI CI systems, GitHub Actions label Sep 4, 2021
@matthewfeickert matthewfeickert self-assigned this Sep 4, 2021
@codecov
Copy link

codecov bot commented Sep 4, 2021

Codecov Report

Merging #1589 (ec5cd31) into master (173c3c7) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1589   +/-   ##
=======================================
  Coverage   97.70%   97.70%           
=======================================
  Files          63       63           
  Lines        4050     4050           
  Branches      576      576           
=======================================
  Hits         3957     3957           
  Misses         54       54           
  Partials       39       39           
Flag Coverage Δ
contrib 25.43% <ø> (ø)
unittests 97.48% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 173c3c7...ec5cd31. Read the comment docs.

- name: Test with pytest
run: |
python -m pytest -r sx --ignore tests/benchmarks/ --ignore tests/contrib --ignore tests/test_notebooks.py
# Run on tests/ to skip doctests of src given examples are for latest APIs
python -m pytest -r sx --ignore tests/benchmarks/ --ignore tests/contrib --ignore tests/test_notebooks.py tests/
Copy link
Member Author

Choose a reason for hiding this comment

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

@kratsg I'm not sure if there is an easier way to do this that running explicitly over tests/.

Is there a way at the command line to negate the --doctest-modules from

addopts = "--ignore=setup.py --ignore=validation/ --ignore=binder/ --ignore=docs/ --cov=pyhf --cov-report=term-missing --cov-config=.coveragerc --cov-report xml --doctest-modules --doctest-glob='*.rst'"

?

Copy link
Contributor

Choose a reason for hiding this comment

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

Nope

Copy link
Member Author

Choose a reason for hiding this comment

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

Okay, cool. This is ready for review then. :)

@matthewfeickert matthewfeickert marked this pull request as ready for review September 4, 2021 17:19
@matthewfeickert
Copy link
Member Author

I'm going to just merge this as it should be uncontroversial as it is extra tests, but let me know if anyone wants changes made in another PR. 👍

@matthewfeickert matthewfeickert merged commit 1f8f7a0 into master Sep 5, 2021
@matthewfeickert matthewfeickert deleted the fix/ignore-doctest-minimum-supported branch September 5, 2021 06:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI CI systems, GitHub Actions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants