Show More
@@ -16,4 +16,3 b' on the IPython GitHub wiki.' | |||||
16 | :maxdepth: 1 |
|
16 | :maxdepth: 1 | |
17 |
|
17 | |||
18 | release_process |
|
18 | release_process | |
19 | making_release |
|
@@ -62,8 +62,23 b' To find duplicates and update `.mailmap`, use::' | |||||
62 |
|
62 | |||
63 | git log --format="%aN <%aE>" $PREV_RELEASE... | sort -u -f |
|
63 | git log --format="%aN <%aE>" $PREV_RELEASE... | sort -u -f | |
64 |
|
64 | |||
|
65 | 3. Make sure the repository is clean | |||
|
66 | ------------------------------------ | |||
65 |
|
67 | |||
66 | 3. Run the `tools/build_release` script |
|
68 | of any file that could be problematic. | |
|
69 | Remove all non-tracked files with: | |||
|
70 | ||||
|
71 | .. code:: | |||
|
72 | ||||
|
73 | git clean -xfdi | |||
|
74 | ||||
|
75 | This will ask for confirmation before removing all untracked files. Make | |||
|
76 | sure the ``dist/`` folder is clean to avoid any stale builds from | |||
|
77 | previous build attempts. | |||
|
78 | ||||
|
79 | ||||
|
80 | ||||
|
81 | 4. Run the `tools/build_release` script | |||
67 | --------------------------------------- |
|
82 | --------------------------------------- | |
68 |
|
83 | |||
69 | Running `tools/build_release` does all the file checking and building that |
|
84 | Running `tools/build_release` does all the file checking and building that | |
@@ -72,11 +87,21 b' the build procedure runs OK, and tests other steps in the release process.' | |||||
72 |
|
87 | |||
73 | We encourage creating a test build of the docs as well. |
|
88 | We encourage creating a test build of the docs as well. | |
74 |
|
89 | |||
75 |
|
|
90 | 5. Create and push the new tag | |
76 | ------------------------------ |
|
91 | ------------------------------ | |
77 |
|
92 | |||
78 | Edit `IPython/core/release.py` to have the current version. |
|
93 | Edit `IPython/core/release.py` to have the current version. | |
79 |
|
94 | |||
|
95 | in particular, update version number and ``_version_extra`` content in | |||
|
96 | ``IPython/core/release.py``. | |||
|
97 | ||||
|
98 | Make sure the version number matches pep440, in particular, `rc` and `beta` are | |||
|
99 | not separated by `.` or the `sdist` and `bdist` will appear as different | |||
|
100 | releases. For example, a valid version number for a release candidate (rc) | |||
|
101 | release is: ``1.3rc1``. Notice that there is no separator between the '3' and | |||
|
102 | the 'r'. | |||
|
103 | ||||
|
104 | ||||
80 | Commit the changes to release.py and jsversion:: |
|
105 | Commit the changes to release.py and jsversion:: | |
81 |
|
106 | |||
82 | git commit -am "release $VERSION" |
|
107 | git commit -am "release $VERSION" | |
@@ -92,7 +117,7 b' Update release.py back to `x.y-dev` or `x.y-maint`, and push::' | |||||
92 | git commit -am "back to development" |
|
117 | git commit -am "back to development" | |
93 | git push origin $BRANCH |
|
118 | git push origin $BRANCH | |
94 |
|
119 | |||
95 |
|
|
120 | 6. Get a fresh clone | |
96 | -------------------- |
|
121 | -------------------- | |
97 |
|
122 | |||
98 | Get a fresh clone of the tag for building the release:: |
|
123 | Get a fresh clone of the tag for building the release:: | |
@@ -100,19 +125,30 b' Get a fresh clone of the tag for building the release::' | |||||
100 | cd /tmp |
|
125 | cd /tmp | |
101 | git clone --depth 1 https://github.com/ipython/ipython.git -b "$TAG" |
|
126 | git clone --depth 1 https://github.com/ipython/ipython.git -b "$TAG" | |
102 |
|
127 | |||
103 |
|
|
128 | 7. Run the release script | |
104 | ------------------------- |
|
129 | ------------------------- | |
105 |
|
130 | |||
106 | Run the `release` script:: |
|
131 | Run the `release` script, this step requires having a current wheel, Python >=3.4 and Python 2.7.:: | |
107 |
|
132 | |||
108 | cd tools && ./release |
|
133 | cd tools && ./release | |
109 |
|
134 | |||
110 |
This makes the tarballs, zipfiles, and wheels |
|
135 | This makes the tarballs, zipfiles, and wheels, and put them under the `dist/` | |
111 | them to archive.ipython.org and registers the release with PyPI. |
|
136 | folder. Be sure to test the ``wheel`` and the ``sdist`` locally before uploading | |
|
137 | them to PyPI. | |||
|
138 | ||||
|
139 | Use the following to actually upload the result of the build: | |||
|
140 | ||||
|
141 | ./release upload | |||
112 |
|
142 | |||
113 | This step requires having a current wheel, Python 3.4 and Python 2.7. |
|
143 | It should posts them to ``archive.ipython.org`` and registers the release | |
|
144 | with PyPI if you have the various authorisations. | |||
114 |
|
145 | |||
115 | 7. Draft a short release announcement |
|
146 | You might need to use `twine <https://github.com/pypa/twine>`_ (`twine upload | |
|
147 | dist/*`) manually to actually upload on PyPI. Unlike setuptools, twine is able | |||
|
148 | to upload packages over SSL. | |||
|
149 | ||||
|
150 | ||||
|
151 | 8. Draft a short release announcement | |||
116 | ------------------------------------- |
|
152 | ------------------------------------- | |
117 |
|
153 | |||
118 | The announcement should include: |
|
154 | The announcement should include: | |
@@ -121,9 +157,9 b' The announcement should include:' | |||||
121 | - a link to the html version of the *What's new* section of the documentation |
|
157 | - a link to the html version of the *What's new* section of the documentation | |
122 | - a link to upgrade or installation tips (if necessary) |
|
158 | - a link to upgrade or installation tips (if necessary) | |
123 |
|
159 | |||
124 | Post the announcement to the mailing list, and link from Twitter. |
|
160 | Post the announcement to the mailing list and or blog, and link from Twitter. | |
125 |
|
161 | |||
126 |
|
|
162 | 9. Update milestones on GitHub | |
127 | ------------------------------ |
|
163 | ------------------------------ | |
128 |
|
164 | |||
129 | These steps will bring milestones up to date: |
|
165 | These steps will bring milestones up to date: | |
@@ -132,8 +168,8 b' These steps will bring milestones up to date:' | |||||
132 | - open a new milestone for the next release (x, y+1), if the milestone doesn't |
|
168 | - open a new milestone for the next release (x, y+1), if the milestone doesn't | |
133 | exist already |
|
169 | exist already | |
134 |
|
170 | |||
135 |
|
|
171 | 10. Update the IPython website | |
136 | ----------------------------- |
|
172 | ------------------------------ | |
137 |
|
173 | |||
138 | The IPython website should document the new release: |
|
174 | The IPython website should document the new release: | |
139 |
|
175 | |||
@@ -141,7 +177,7 b' The IPython website should document the new release:' | |||||
141 | - update current version and download links |
|
177 | - update current version and download links | |
142 | - update links on the documentation page (especially if a major release) |
|
178 | - update links on the documentation page (especially if a major release) | |
143 |
|
179 | |||
144 |
1 |
|
180 | 11. Celebrate! | |
145 | -------------- |
|
181 | -------------- | |
146 |
|
182 | |||
147 | Celebrate the release and please thank the contributors for their work. Great |
|
183 | Celebrate the release and please thank the contributors for their work. Great |
1 | NO CONTENT: file was removed |
|
NO CONTENT: file was removed |
General Comments 0
You need to be logged in to leave comments.
Login now