Repository navigation
Add formatting, docs-build and wheel-install checks to CI; drop Python 3.9 - #162
Merged
Merged
Conversation
Add three jobs alongside the test matrix: "format" runs black --check; "docs" builds the documentation with Sphinx on Python 3.11, as ReadTheDocs does, treating warnings as errors; and "package" builds the wheel, installs it in a clean virtual environment and imports every fairgraph module from it, outside the source tree. The format job pins black to major version 26, so that a new year's stable style doesn't make every pull request fail. The contributing guide now gives the black and sphinx-build commands, so these checks can be run locally.
Python 3.9 has reached end of life, and the latest releases of requests and tabulate already require Python 3.10.
This file contains hidden or 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
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.
Fixes #124.
Currently, CI runs flake8 (syntax errors and undefined names only) and pytest, always against an editable install. This PR adds three jobs alongside the test matrix:
black --check --diff ., with black pinned to major version 26, so that the new stable style that black introduces each January doesn't make every pull request fail. Updating black then means bumping the pin in a commit that also reformats the code.-W --keep-going, so that a broken reference or malformed markup fails the pull request rather than surfacing later on ReadTheDocs. The documentation currently builds with no warnings.fairgraphmodule from it, outside the source tree, so that a packaging error (e.g., a subpackage missing from[tool.setuptools.packages.find]) cannot reach PyPI. This check found the brokenfairgraph.fieldsmodule removed in Remove deprecated aliases from the renaming of fields to properties #161.The contributing guide now gives the black and
sphinx-buildcommands, so these checks can be run locally.A second commit drops support for Python 3.9, which has reached end of life, and adds Python 3.15 to the test matrix.
requires-pythonbecomes>=3.10, and black's target version becomespy310(which does not change the formatting). The latest releases of requests and tabulate already require Python 3.10. The 0.16.0 release notes mention the change.