Skip to content

DOC Add policy to upper bound build deps in maintainers page #31345

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

Merged
merged 3 commits into from
May 13, 2025
Merged

DOC Add policy to upper bound build deps in maintainers page #31345

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7d3c2b0
add policy to upper bound build deps in maintainers page
jeremiedbb May 9, 2025
484a269
Update doc/developers/maintainer.rst.template
jeremiedbb May 12, 2025
df21acd
remove blank space
jeremiedbb May 12, 2025
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
14 changes: 14 additions & 0 deletions doc/developers/maintainer.rst.template
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,9 @@ Reference Steps
* [ ] Update the sklearn dev0 version in main branch
{%- endif %}
* [ ] Set the version number in the release branch
{% if key == "rc" -%}
* [ ] Set an upper bound on build dependencies in the release branch
{%- endif %}
* [ ] Generate the changelog in the release branch
* [ ] Check that the wheels for the release can be built successfully
* [ ] Merge the PR with `[cd build]` commit message to upload wheels to the staging repo
Expand Down Expand Up @@ -162,6 +165,17 @@ Reference Steps
- In the release branch, change the version number `__version__` in
`sklearn/__init__.py` to `{{ version_full }}`.

{% if key == "rc" %}
- Still in the release branch, set or update the upper bound on the build
dependencies in the `[build-system]` section of `pyproject.toml`. The goal is to
prevent future backward incompatible releases of the dependencies to break the
build in the maintenance branch.

The upper bounds should match the latest already-released minor versions of the
dependencies and should allow future micro (bug-fix) versions. For instance, if
numpy 2.2.5 is the most recent version, its upper bound should be set to <2.3.0.
{% endif %}

- In the release branch, generate the changelog for the incoming version, i.e.,
`doc/whats_new/{{ version_short }}.rst`.
{%- if key == "rc" %}
Expand Down