Skip to content

Commit 7cab9bd

Browse files
committed
DOC: add doc on making a release
1 parent 7ca9faa commit 7cab9bd

File tree

2 files changed

+49
-0
lines changed

2 files changed

+49
-0
lines changed

doc/developers/maintainer.rst

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
Maintainer / core-developer information
2+
========================================
3+
4+
Making a release
5+
------------------
6+
7+
1. Update docs:
8+
9+
- edit the doc/whats_new.rst file to add release title and commit
10+
statistics. You can retrieve commit statistics with::
11+
12+
$ git shortlog -ns 0.998..
13+
14+
- edit the doc/conf.py to increase the version number
15+
16+
- edit the doc/themes/scikit-learn/layout.html to change the 'News'
17+
entry of the front page.
18+
19+
2. Update the version number in sklearn/__init__.py, the __version__
20+
variable
21+
22+
3. Create the tag and push it::
23+
24+
$ git tag 0.999
25+
26+
$ git push origin --tags
27+
28+
4. create tarballs:
29+
30+
- Wipe clean your repo::
31+
32+
$ git clean -xfd
33+
34+
- Register and upload on PyPI::
35+
36+
$ python setup.py sdist register upload
37+
38+
- Upload manually the tarbal on sourceforge:
39+
https://sourceforge.net/projects/scikit-learn/files/
40+
41+
5. Push the documentation to the website (see README in doc folder)
42+
43+
44+
6. Build binaries for windows and push them to PyPI::
45+
46+
$ python setup.py bdist_wininst upload
47+
48+
And upload them also to sourceforge

doc/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,7 @@ Development
247247
developers/performance
248248
developers/utilities
249249
developers/debugging
250+
developers/maintainer
250251
about
251252

252253
.. toctree::

0 commit comments

Comments
 (0)