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.

Sign up for GitHub

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

MNT: Drop Python 3.7 and update test matrix again #177

Merged
merged 4 commits into from
Aug 17, 2023
Merged

MNT: Drop Python 3.7 and update test matrix again #177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
62fc358
MNT: Drop Python 3.7
pllim Aug 17, 2023
2806ce1
TST: Update matrix more
pllim Aug 17, 2023
ff52337
TST: Add back sphinx53
pllim Aug 17, 2023
8497ebc
TST: Use sphinx_oldest in tox
pllim Aug 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions .github/workflows/ci_workflows.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,39 +28,42 @@ jobs:

# Linux - test different Sphinx versions
- os: ubuntu-latest
python-version: 3.7
toxenv: py37-test-sphinx40
python-version: 3.8
toxenv: py38-test-sphinx_oldest
- os: ubuntu-latest
python-version: 3.8
toxenv: py38-test-sphinx53
- os: ubuntu-latest
python-version: 3.9
toxenv: py39-test-sphinx62
- os: ubuntu-latest
python-version: 3.9
toxenv: py39-test-sphinx70
- os: ubuntu-latest
python-version: '3.10'
toxenv: py310-test-sphinx70
toxenv: py310-test-sphinx71
- os: ubuntu-latest
python-version: '3.11'
toxenv: py311-test-sphinx71-cov-clocale
toxenv: py311-test-sphinx72-cov-clocale
- os: ubuntu-latest
python-version: '3.12-dev'
toxenv: py312-test-sphinxdev

# MacOS X - just the stable and dev
- os: macos-latest
python-version: '3.10'
toxenv: py310-test-sphinx71-clocale
toxenv: py310-test-sphinx72-clocale
- os: macos-latest
python-version: '3.11'
toxenv: py311-test-sphinxdev

# Windows - just the oldest, stable, and dev
- os: windows-latest
python-version: 3.7
toxenv: py37-test-sphinx40
python-version: 3.8
toxenv: py38-test-sphinx40
- os: windows-latest
python-version: '3.10'
toxenv: py310-test-sphinx71
toxenv: py310-test-sphinx72
- os: windows-latest
python-version: '3.11'
toxenv: py311-test-sphinxdev
Expand Down
2 changes: 2 additions & 0 deletions CHANGES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ Changes in sphinx-automodapi
0.17.0 (unreleased)
-------------------

- Minimum supported Python version is now 3.8. [#177]

0.16.0 (2023-08-17)
-------------------

Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ classifiers =
[options]
zip_safe = False
packages = find:
python_requires = >=3.7
python_requires = >=3.8
install_requires =
sphinx>=4

Expand Down
5 changes: 3 additions & 2 deletions tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
[tox]
envlist = py{37,38,39,310,311,312}-test-sphinx{40,53,62,70,71,dev}{-cov}{-clocale}
envlist = py{38,39,310,311,312}-test-sphinx{_oldest,53,62,70,71,72,dev}{-cov}{-clocale}
requires = pip >= 18.0
setuptools >= 30.3.0
isolated_build = true

[testenv]
changedir = .tmp/{envname}
deps =
sphinx40: sphinx==4.0.*
sphinx_oldest: sphinx==4.0.0
sphinx53: sphinx==5.3.*
sphinx62: sphinx==6.2.*
sphinx70: sphinx==7.0.*
sphinx71: sphinx==7.1.*
Copy link
Member

Choose a reason for hiding this comment

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

Isn't this considered major release? I would consider keeping this for now.

Copy link
Member Author

Choose a reason for hiding this comment

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

Given all the breakage from yesterday, I guess, LoL. Can I drop "7.0" then? I don't want to keep a super long list of old Sphinx releases.

Copy link
Member

Choose a reason for hiding this comment

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

I would say wait? It's released back in April, and maybe there are still some <7.1 pins around. I don't expect much failures, but then we also don't run the test suite that often that it should be that big of a deal to cover all cases.

Dropping down to a single version for old major numbers sounds good though.

Copy link
Member Author

Choose a reason for hiding this comment

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

Do you have a preference between 5.3 and 6.2?

Copy link
Member

Choose a reason for hiding this comment

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

One of 5.x.y and 6.z.w should be enough I think. Actually I would stay with the oldest on each major versions, but it's not at all a strong preference. for "oldest" though I would very much use the same that is declared as dependency, so would hard wire '4.0.0' rather than allowing it to pick-up the lastest bugfix.

Copy link
Member Author

Choose a reason for hiding this comment

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

hard wire '4.0.0' rather than allowing it to pick-up the lastest bugfix

Wouldn't it make sense to pick up the bug fixes too? I don't promise it would work with a buggy release for other versions.

Copy link
Member

Choose a reason for hiding this comment

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

Wouldn't it make sense to pick up the bug fixes too?

No, I think that would be the same logic of supporting only the latest and greatest version, as that one has the most features and fixes.

My logic here is that the config files state a minimum required version, our task is to make sure that minimum is in fact the minimum and not just aspiration, therefore that minimum should be the one tested.

Copy link
Member Author

Choose a reason for hiding this comment

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

I think I addressed your comments but I am not sure. Please re-review. Thanks!

Copy link
Member

Choose a reason for hiding this comment

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

Oh, I mean keep one of each of the major versions (e.g. don't drop 5.x.y), but one should be enough, no need for multiple between 5.x and 6.y

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, what about now?

sphinx72: sphinx==7.2.*
sphinxdev: git+https://github.com/sphinx-doc/sphinx.git
extras =
test: test
Expand Down