Skip to content

DOC Update maintainer doc for release from scikit-learn-release workflow - #35332

Merged
lesteve merged 9 commits into
scikit-learn:mainfrom
lesteve:update-release-doc-from-scikit-learn-release
Nov 16, 2026
Merged

lesteve merged 9 commits into
scikit-learn:mainfrom
lesteve:update-release-doc-from-scikit-learn-release

Conversation

@lesteve

@lesteve lesteve commented Nov 6, 2026 •

Copy link
Copy Markdown
Member

This is an first attempt to update the maintainer doc for releasing from the https://github.com/scikit-learn/scikit-learn-release repo following scikit-learn/scikit-learn-release#18.

Comments more than welcome!

The real test will be when @betatim will actually try to do the release. It's quite likely that the doc can be further improved then.

cc @betatim @virchan @jeremiedbb.

Comment thread doc/developers/maintainer.rst.template Resolved
Comment thread doc/developers/maintainer.rst.template Resolved
Comment thread doc/developers/maintainer.rst.template Resolved
@lesteve lesteve added this to Labs Nov 9, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Labs Nov 9, 2026
@lesteve lesteve added this to the 1.10 milestone Nov 9, 2026
@lesteve lesteve moved this from Todo to PR waiting for reviews in Labs Nov 9, 2026

@AnneBeyer AnneBeyer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you @lesteve, I think I understand the whole process a bit better now. I added a few questions/comments below.


- The release manager must be a **maintainer** of the
https://github.com/conda-forge/scikit-learn-feedstock repository to be able to publish
on `conda-forge`. This can be changed by editing the `recipe/meta.yaml` file in the

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Unrelated to the changes here, but this file was renamed to recipe/recipe.yaml in conda-forge/scikit-learn-feedstock#290.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Good point, PR more than welcome to fix it 🙏! Ping me and I'll merge it quickly.

and the final release afterwards should include only minor documentation changes
and bug fixes. Any major enhancement or new feature should be excluded.

- Create the release branch `{{ version_short }}.X` directly in the main repository,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Maybe this is obvious to maintainers, but it could be made explicit that "main repository" references scikit-learn here (and not scikit-learn-release).

Comment thread doc/developers/maintainer.rst.template Resolved
Comment thread doc/developers/maintainer.rst.template Resolved
<https://github.com/scikit-learn/scikit-learn/actions/workflows/publish_pypi.yml>`_
again, but this time to upload the artifacts to the real https://pypi.org/. To do
so, replace `testpypi` with `pypi` in the "Run workflow" form.
- In the same `publish.yml` workflow run, a release team member can

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Having not gone through the process yet, this part is not totally clear to me: Does this happen during the first run? And if so, should there be a note above that only the test upload should be approved first? Or does this require a re-trigger of the workflow (as in the old version)?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

It's in the same workflow run, basically you have manual approval in the middle of the workflow something like this:

  • manual trigger (workflow_dispatch)
  • build wheels
  • manual approval to upload to testPyPI
  • upload to testPyPI when approved
  • here you can install from testPyPI and run the tests locally to make 100% sure everything looks good
  • manual approval to upload to PyPI
  • upload to PyPI when approved

https://github.com/scikit-learn/scikit-learn-release/actions/workflows/publish.yml

- The `publish.yml` workflow will first build the wheel, then ask for
approval from a release team member to upload it to `testPyPI` (through

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Just for my understanding: can this be the same person that started the workflow?

@lesteve lesteve Nov 16, 2026 •

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

There is a setting to enable self-review, I think it is not enabled for now (not 100% sure I need to double-check).

Co-authored-by: Anne Beyer <anne.beyer@mailbox.org>
@github-actions github-actions Bot added size/XL and removed size/M labels Nov 16, 2026
@github-actions github-actions Bot added size/M and removed size/XL labels Nov 16, 2026
@ogrisel

ogrisel commented Nov 16, 2026 •

Copy link
Copy Markdown
Member

@lesteve The switch the CRLF line endings makes it impossible to view the lines changed by this PR. I suppose this is caused by a bug in GitHub.

I pushed a commit to revert the line endings back to LF only.

EDIT: for reference, it seems that CPython developers also faced this bug in the passed and decided to hard-code LF as a result in .gitattributes: python/cpython#148739

@ogrisel ogrisel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The doc change LGTM from a cursory glance but I guess the real check will happen once @betatim gives it a try.

@lesteve I just added a suggestion to make it explicit that manual upload should only serve as a fallback in case trusted publishing does not work anymore (and would require changing settings on the pypi.org side).

Comment thread doc/developers/maintainer.rst.template Resolved
Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org>
@lesteve
lesteve enabled auto-merge (squash) November 16, 2026 14:50
@lesteve
lesteve merged commit a30a70e into scikit-learn:main Nov 16, 2026
36 checks passed
@github-project-automation github-project-automation Bot moved this from PR waiting for reviews to Done in Labs Nov 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants