Skip to content

deps: put docutils in its own dependabot group - #198

Open
aliviahossain wants to merge 5 commits into
OpenMS:mainfrom
aliviahossain:fix/dependabot-docutils
Open

aliviahossain wants to merge 5 commits into
OpenMS:mainfrom
aliviahossain:fix/dependabot-docutils

Conversation

@aliviahossain

@aliviahossain aliviahossain commented Nov 1, 2026 •

Copy link
Copy Markdown
Contributor

@jcharkow Following up on the discussion, this replaces the docutils>=0.23 ignore rule with a separate docutils-updates group.

Dependabot bumps each pin in requirements.txt without a resolver, because there is no .in file. With docutils in sphinx-updates, the docutils==0.23 bump blocked the whole group, since sphinx 9.1 needs docutils<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 recreate on #209 should rebuild it without docutils.

Summary by CodeRabbit

  • Chores
    • Automated update proposals for docutils are now handled separately from other documentation-related updates. This changes how these dependency updates are grouped; it does not change application features or behavior.

sphinx 9.1 requires docutils<0.23, so grouping them produced an unresolvable install (OpenMS#190).
@coderabbitai

coderabbitai Bot commented Nov 1, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The Dependabot configuration removes docutils from the Sphinx update group and places it in a separate group. Comments describe how Dependabot handles pinned dependencies and how an unsupported docutils release can affect Sphinx updates.

Changes: Dependabot update groups

Layer / File(s) Summary
Separate docutils updates
.github/dependabot.yml
The configuration removes docutils from the Sphinx patterns and creates a separate docutils-updates group. Comments describe the resolver limitation and the potential effect of an unsupported docutils release on the Sphinx group.

Suggested reviewers: jcharkow

Change: Other

Merge Risk: Minimal · up to 53721

This changes how Dependabot groups docutils updates so that an incompatible docutils bump becomes its own PR instead of blocking the Sphinx group. It has no runtime impact and is low risk to merge.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title names the main change: docutils moves into its own Dependabot group. The raw summary confirms that docutils is removed from the sphinx-updates group and given a separate docutils-updates gro…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Full details: Title check

Explanation

The title names the main change: docutils moves into its own Dependabot group. The raw summary confirms that docutils is removed from the sphinx-updates group and given a separate docutils-updates group in .github/dependabot.yml. The objectives match this approach, so the title is specific and accurate.

Finishing Touches

Generate unit tests (beta)

  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

A rabbit reads the update list,
One group for Sphinx, one for docutils.
Pins hop along without a guide,
Separate paths keep bumps untied.
The rabbit nods and nibbles greens.

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: fef8ec04-691a-40c9-ab34-b2617840b1f3
Commits

Reviewing files that changed from the base of the PR and between 1aaf26e and 53721a3.

Files selected for processing: 1

  • .github/dependabot.yml

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

@openmsgithubapp

Copy link
Copy Markdown

📖 Documentation Preview

The documentation for this PR has been built and is available at:
🔗 View Preview

This preview will be updated automatically when you push new commits to this PR.


Preview built from commit: 3554147

openmsgithubapp Bot pushed a commit that referenced this pull request Nov 3, 2026
@jcharkow

jcharkow commented Nov 3, 2026

Copy link
Copy Markdown
Collaborator

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?

@aliviahossain

Copy link
Copy Markdown
Contributor Author

@jcharkow Sure, I'll research and post a report in a day or two. Currently travelling.

@aliviahossain

Copy link
Copy Markdown
Contributor Author

@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?

@jcharkow

jcharkow commented Nov 9, 2026

Copy link
Copy Markdown
Collaborator

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

@openmsgithubapp

Copy link
Copy Markdown

📖 Documentation Preview

The documentation for this PR has been built and is available at:
🔗 View Preview

This preview will be updated automatically when you push new commits to this PR.


Preview built from commit: de13606

openmsgithubapp Bot pushed a commit that referenced this pull request Nov 9, 2026
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.
@aliviahossain aliviahossain changed the title deps: ignore docutils>=0.23 in dependabot deps: put docutils in its own dependabot group Nov 15, 2026
@aliviahossain

Copy link
Copy Markdown
Contributor Author

@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.

openmsgithubapp Bot pushed a commit that referenced this pull request Nov 15, 2026
@openmsgithubapp

Copy link
Copy Markdown

📖 Documentation Preview

The documentation for this PR has been built and is available at:
🔗 View Preview

This preview will be updated automatically when you push new commits to this PR.


Preview built from commit: ac4c46e

1 similar comment
@openmsgithubapp

Copy link
Copy Markdown

📖 Documentation Preview

The documentation for this PR has been built and is available at:
🔗 View Preview

This preview will be updated automatically when you push new commits to this PR.


Preview built from commit: ac4c46e

openmsgithubapp Bot pushed a commit that referenced this pull request Nov 15, 2026

This branch has not been deployed

No deployments
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.

2 participants