Repository navigation
deps: put docutils in its own dependabot group - #198
aliviahossain wants to merge 5 commits into
Conversation
sphinx 9.1 requires docutils<0.23, so grouping them produced an unresolvable install (OpenMS#190).
|
No actionable comments were generated in the recent review. Walkthrough
Change: Other Merge Risk:
|
|
📖 Documentation Preview The documentation for this PR has been built and is available at: This preview will be updated automatically when you push new commits to this PR. Preview built from commit: |
|
I know that this solution has been used in the past but I am not completely happy with it since it requires manual adjustments in the future which will likely get forgotten. Can you do a bit of research to see if there are other options? Perhaps they should not be put in the same dependencies group? |
|
@jcharkow Sure, I'll research and post a report in a day or two. Currently travelling. |
|
@jcharkow Finally got some time to investigate. Our requirements files are generated by pip-compile --all-extras straight from pyproject.toml, with no .in file. Depenadbot only treats a file as pip-compile output when a .in exists. Otherwise it bumps every pin on its own, with no resolver. sphinx 9.2 now allows docutils<0.24, but it requires Python 3.13+, and our lock and CI are on 3.12. So "lift once sphinx supports newer docutils" is already misleading, and Dependabot will propose sphinx 9.2, which can't install on 3.12 either. Splitting docutils into its own group helps a bit only. The rest of the sphinx updates aren't blocked, and a bad docutils bump can be closed as a single PR. But it doesn't stop incompatible combinations. The proper fix is moving to Dependabot's uv ecosystem with a uv.lock. Every update gets resolved, the lock can hold different versions for 3.12 and 3.13+, and we can generate the root, docs and binder requirement files from one source, which have already drifted (sphinx 9.0.4 in root vs 8.1.3 in docs/). Adding a requirements.in is another option, but Dependabot doesn't carry over --all-extras, so the extras would have to move into the .in, and I'd prefer the former option. Plan: I'll first try the uv setup on my personal fork, with Dependabot turned on there, so we can see the actual PRs it opens and confirm CI passes before touching this repo. Meanwhile I can change this PR to split docutils into its own group instead of ignoring it. Does that sound good? |
|
I know that uv is the way forward with python management but I think we should stick with the requirements.txt for now. I don't think dependabot's support for uv is that mature and we may run into further issues considering the many dependecies in the repository. You are welcome play around with it but its not a must. I think splitting the docutils into its own group in the meantime is a good idea |
|
📖 Documentation Preview The documentation for this PR has been built and is available at: This preview will be updated automatically when you push new commits to this PR. Preview built from commit: |
Replaces the docutils>=0.23 ignore rule. Dependabot bumps each pin in requirements.txt without a resolver, so a docutils release sphinx doesn't support yet (sphinx 9.1 needs docutils<0.23) broke the whole sphinx-updates group. With docutils in its own group, the rest of the sphinx stack can update and an incompatible docutils bump is a single PR to close.
|
@jcharkow Done. I removed the ignore rule and moved docutils into its own docutils-updates group. Now an incompatible docutils bump comes as its own PR that can be closed, and the rest of the sphinx stack (#209) can update. I checked #209's pins without docutils 0.23, and they resolve on Python 3.12, 3.13 and 3.14. After merging, I believe @dependabot recreate on #209 should rebuild it without docutils. |
|
📖 Documentation Preview The documentation for this PR has been built and is available at: This preview will be updated automatically when you push new commits to this PR. Preview built from commit: |
1 similar comment
|
📖 Documentation Preview The documentation for this PR has been built and is available at: This preview will be updated automatically when you push new commits to this PR. Preview built from commit: |
@jcharkow Following up on the discussion, this replaces the
docutils>=0.23ignore rule with a separatedocutils-updatesgroup.Dependabot bumps each pin in
requirements.txtwithout a resolver, because there is no.infile. With docutils insphinx-updates, thedocutils==0.23bump blocked the whole group, since sphinx 9.1 needsdocutils<0.23(#190, #209). With the split, the rest of the sphinx stack can update. I checked #209's pins without the docutils bump, and they resolve on Python 3.12, 3.13 and 3.14. An incompatible docutils bump now arrives as its own PR that can be closed.After merging,
@dependabot recreateon #209 should rebuild it without docutils.Summary by CodeRabbit
docutilsare now handled separately from other documentation-related updates. This changes how these dependency updates are grouped; it does not change application features or behavior.