Skip to content

DOC minor updates to release process #21172

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 2 commits into from
Sep 29, 2021
Merged

DOC minor updates to release process #21172

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e2aa3fb
DOC update release process
adrinjalali Sep 27, 2021
fbc5239
Update doc/developers/maintainer.rst
glemaitre Sep 28, 2021
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
17 changes: 10 additions & 7 deletions doc/developers/maintainer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,12 @@ Making a release

https://github.com/scikit-learn/scikit-learn/actions?query=workflow%3A%22Publish+to+Pypi%22

4.1 You can test the conda-forge builds by submitting a PR to the feedstock
repo: https://github.com/conda-forge/scikit-learn-feedstock. If you want to
publish an RC release on conda-forge, the PR should target the `rc` branch
Copy link
Member

Choose a reason for hiding this comment

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

Could we make it in bold regarding the rc branch. I think this is something that could be easily overlooked.

Copy link
Member Author

Choose a reason for hiding this comment

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

I personally don't check a rendered version of this doc, so I'm not sure making it bold would help.

as opposed to the `master` branch. The two branches need to be kept sync
together otherwise.

5. If this went fine, you can proceed with tagging. Proceed with caution.
Ideally, tags should be created when you're almost certain that the release
is ready, since adding a tag to the main repo can trigger certain automated
Expand Down Expand Up @@ -272,11 +278,11 @@ Making a release
git clone --depth 1 --no-checkout git@github.com:scikit-learn/scikit-learn.github.io.git
cd scikit-learn.github.io
echo stable > .git/info/sparse-checkout
git checkout master
git checkout main
rm stable
ln -s 0.999 stable
sed -i "s/latestStable = '.*/latestStable = '0.999';/" versionwarning.js
git add stable/ versionwarning.js
git add stable versionwarning.js
git commit -m "Update stable to point to 0.999"
git push origin master

Expand All @@ -293,14 +299,11 @@ The following GitHub checklist might be helpful in a release PR::
* [ ] merge the PR with `[cd build]` commit message to upload wheels to the staging repo
* [ ] upload the wheels and source tarball to https://test.pypi.org
* [ ] create tag on the main github repo
* [ ] upload the wheels and source tarball to PyPI
* [ ] https://github.com/scikit-learn/scikit-learn/releases draft
* [ ] confirm bot detected at
https://github.com/conda-forge/scikit-learn-feedstock and wait for merge
* [ ] upload the wheels and source tarball to PyPI
* [ ] https://github.com/scikit-learn/scikit-learn/releases publish
* [ ] fix the binder release version in ``.binder/requirement.txt`` (see
#15847)
* [ ] announce on mailing list and on twitter
* [ ] announce on mailing list and on Twitter, and LinkedIn

Merging Pull Requests
---------------------
Expand Down