Skip to content

Commit ce4a40f

Browse files
DOC Add policy to upper bound build deps in maintainers page (#31345)
Co-authored-by: Lucy Liu <jliu176@gmail.com>
1 parent e906f0e commit ce4a40f

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

doc/developers/maintainer.rst.template

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,9 @@ Reference Steps
121121
* [ ] Update the sklearn dev0 version in main branch
122122
{%- endif %}
123123
* [ ] Set the version number in the release branch
124+
{% if key == "rc" -%}
125+
* [ ] Set an upper bound on build dependencies in the release branch
126+
{%- endif %}
124127
* [ ] Generate the changelog in the release branch
125128
* [ ] Check that the wheels for the release can be built successfully
126129
* [ ] Merge the PR with `[cd build]` commit message to upload wheels to the staging repo
@@ -162,6 +165,17 @@ Reference Steps
162165
- In the release branch, change the version number `__version__` in
163166
`sklearn/__init__.py` to `{{ version_full }}`.
164167

168+
{% if key == "rc" %}
169+
- Still in the release branch, set or update the upper bound on the build
170+
dependencies in the `[build-system]` section of `pyproject.toml`. The goal is to
171+
prevent future backward incompatible releases of the dependencies to break the
172+
build in the maintenance branch.
173+
174+
The upper bounds should match the latest already-released minor versions of the
175+
dependencies and should allow future micro (bug-fix) versions. For instance, if
176+
numpy 2.2.5 is the most recent version, its upper bound should be set to <2.3.0.
177+
{% endif %}
178+
165179
- In the release branch, generate the changelog for the incoming version, i.e.,
166180
`doc/whats_new/{{ version_short }}.rst`.
167181
{%- if key == "rc" %}

0 commit comments

Comments
 (0)