forked from scikit-image/scikit-image
/
RELEASE.txt
303 lines (227 loc) · 12 KB
/
RELEASE.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
How to make a new release of ``skimage``
========================================
While following this guide, note down all the times that you need to
consult a previous release manager, or that you find an instruction
unclear. You will, of course, make a PR to update these notes after
you are done with the release! ;-)
Some of the instructions don't apply to patch releases. As a reminder, we use a
variant of "semantic versioning", where version numbers are classified as
v<major>.<minor>.<patch>. If you are making a patch release, skip the first
three steps. Instead, make a PR to update ``release_<major>.<minor>.txt`` on
the corresponding release branch.
Before you start, make sure you have all the required write
permissions (if not, you will need to ask an owner to grant you
access), specifically to:
- https://github.com/scikit-image/scikit-image-wheels
- https://pypi.org/project/scikit-image/
- https://github.com/scikit-image/scikit-image-web
- Check ``TODO.txt`` for any outstanding tasks.
- Branch v<major>.<minor>.x from `main`. This is the "release branch", where
you will make your changes gearing up for release, and cherry-pick them as
appropriate to `main`.
- On the release branch, update the release notes:
1. Review and cleanup ``doc/release/release_dev.rst``.
2. Make a list of merges, contributors, and reviewers by running
``tools/generate_release_notes.py -h`` and following that file's usage.
3. Paste this list at the end of the ``release_dev.txt``.
4. Scan the PR titles for highlights, deprecations, API changes,
and bugfixes, and mention these in the relevant sections of the notes.
Try to present the information in an expressive way by mentioning
the affected functions, elaborating on the changes and their
consequences. If possible, organize semantically close PRs in groups.
5. Check for duplicate names in the automatically generated list of
contributors and reviewers
6. Rename the file to ``doc/release/release_<major>.<minor>.txt``
7. Copy ``doc/release/release_template.txt`` to
``doc/release/release_dev.txt`` for the next release.
8. Copy relevant deprecations from ``release_<major>_<minor>.txt``
to ``release_dev.txt``.
- Submit the release notes for review by other project maintainers:
- Create a PR from v<major>.<minor>.x branch to `main` (at this point,
the difference should show the full contents of the release notes).
- Discuss with others, and make the changes directly to v<major>.<minor>.x branch.
- Once the consensus is found, ask the project maintainers to merge
the PR.
- Cherry pick the change onto the release branch.
- On the main branch, update the version number in ``skimage/__init__.py``
to the next ``.dev0`` version, commit, and push. This should follow PEP440
meaning that the appropriate version number would look something like
``0.20.0.dev0`` with the period between ``0`` and ``dev`` and a trailing
``0`` immediately after ``dev``. The final ``0`` is necessary to ensure
that
`NumpyVersion <https://github.com/scikit-image/scikit-image/pull/4947>`_
correctly interprets the version number.
- On the main branch, edit ``doc/source/_static/docversions.js``,
add the release, e.g., `0.15.x`, and commit. Cherry-pick this
change back to the release branch.
- Make sure you have all the required write permissions (if not, you will
need to ask Stéfan or Juan to grant you the access), specifically, to:
- https://github.com/scikit-image/scikit-image-wheels
- https://pypi.org/project/scikit-image/
- https://github.com/scikit-image/scikit-image-web
- Perform the following step first on a release candidate to check the wheels
are building fine. Then proceed with the release.
1. Back on the release branch, update the version number to stable in
``skimage/__init__.py``, commit, and push.
2. Add the version number as a tag in git::
git tag -s -m <github_release_message> [-u <key-id>] v<major>.<minor>.0
(If you do not have a GPG key, follow the tutorial to set it up:
https://help.github.com/articles/signing-commits-with-gpg/)
3. Push the new tag to GitHub::
git push upstream v<major>.<minor>.0<rcversion>
(where ``upstream`` is the name of the
``github.com:scikit-image/scikit-image`` repository.)
4. Build the package wheels (pre-compiled binaries) for various platforms:
- Clone https://github.com/scikit-image/scikit-image-wheels.
- If making a patch release, switch to the appropriate v<major>.<minor>.x
branch. Otherwise, create that branch.
- Update its ``.travis.yml`` file so that ``BUILD_COMMIT`` points to this
release tag (e.g. ``v0.14.0``).
- Update its ``.appveyor.yml`` file so that ``BUILD_COMMIT`` also points to
this release tag.
- Commit and push.
- Monitor the builds at
https://ci.appveyor.com/project/scikit-image/scikit-image-wheels and
https://travis-ci.org/scikit-image/scikit-image-wheels/branches
- If they fail, fix them through self-merging pull requests.
- Remove any build with none-supported Python versions if necessary.
- Add builds for new python version if necessary.
- When all is green, spot-check a couple of builds to make sure that the
wheels have correctly uploaded. You should see a message like:
``python -m wheelhouse_uploader upload --local-folder``, with output:
``Wheelhouse successfully published at:
http://[crazyrandomstring].rackcdn.com``
- Open that URL and check for the wheels as
``scikit_image-<versiontag>-<platforminfo>.whl``
- If you have performed a release candidate, redo the previous steps with the
final release.
- Spot-check a couple of builds to make sure that the
wheels have correctly uploaded. You should see a message like:
``python -m wheelhouse_uploader upload --local-folder``, with output:
``Wheelhouse successfully published at:
http://[crazyrandomstring].rackcdn.com``
- Open that URL and check for the wheels as
``scikit_image-<versiontag>-<platforminfo>.whl``
**Do not tag until the builds are all green.**
- Add the version number as a tag in git::
git tag -s -m <github_release_message> [-u <key-id>] v<major>.<minor>.0
(If you do not have a GPG key, follow the tutorial to set it up:
https://help.github.com/articles/signing-commits-with-gpg/)
- Push the new tag to GitHub::
git push upstream v<major>.<minor>.0
(where ``upstream`` is the name of the
``github.com:scikit-image/scikit-image`` repository.)
- Build the package wheels again, but change BUILD_COMMIT in both
Travis-CI and AppVeyor to the release version, e.g., ``v0.16.0``.
- Upload the wheels to PyPI:
- Make sure ``twine`` is available. You can install it with
``pip install twine``.
- Downlad ``wheel-uploader`` [1]_ and place it on your PATH.
- Make sure authentification with twine is working.
- See https://pypi.org/project/twine/
- Set your PyPI username in the environment variable TWINE_USERNAME
- Set your PyPI password in the environment variable TWINE_PASSWORD
- Run ``tools/upload_wheels.sh``.
- If everything worked, delete the wheels from your local directory with
``rm -rf *.whl``
.. [1] https://github.com/MacPython/terryfy/blob/master/wheel-uploader
- Publish the source distribution on PyPi::
python setup.py sdist
twine upload dist/scikit-image-<major>.<minor>.0.tar.gz
- Update the release docs:
- Edit ``doc/source/_static/docversions.js`` and commit
- On the release branch, build a clean version of the docs. In the
root directory, run ``pip install .``.
- In the ``doc/`` directory:
- Build using
``make clean; make html; make gh-pages``.
- Check (since this a new feature) that binder links in gallery examples
point to the release branch, e.g. `0.16.x`.
- In the ``gh-pages/`` directory:
- Update the symlink to ``stable`` and commit.
- Upload the docs: ``git push origin gh-pages`` in ``doc/gh-pages``.
- Update the web frontpage:
The webpage source is kept in a separate repo: `scikit-image-web`.
- Add release date to ``index.rst`` under "News".
- Add previous stable version documentation path to disallowed paths
in `robots.txt`
- Commit and push (this will also build and update the website).
- Post release notes on mailing lists, blog, Twitter, etc.
- scikit-image@python.org
- scipy-user@python.org
- scikit-learn@python.org
- Update the version and the release date on Wikipedia
https://en.wikipedia.org/wiki/Scikit-image
- Make a PR to scikit-image with any updates you might have to these notes
- If making a patch release (v<major>.<minor>.<patch>), forward-port the
release notes to the main branch and make a PR.
Conda-forge
-----------
**Note**: conda-forge now has an automated bot who makes the below PR for you.
Now all you have to do is to look at pull requests at
https://github.com/conda-forge/scikit-image-feedstock/pulls
and check for a new one for this version. Wait for all the continuous
integration checks to go green, then merge.
The manual instructions remain below in case the bot fails for some reason.
A scikit-image build recipe resides at
https://github.com/conda-forge/scikit-image-feedstock. You should update it to
point to the most recent release. You can do this by following these steps:
- Fork the repository at https://github.com/conda-forge/scikit-image-feedstock,
and clone it to your machine.
- Sprout a new branch, e.g. ``v<major>.<minor>``.
- Find out the SHA256 hash of the source distribution. You can find this at
https://pypi.org/project/scikit-image/, or use the following commands:
- ``sha256sum path/to/scikit-image-*.tar.gz`` (Linux)
- ``shasum -a 256 dist/scikit-image-*.tar.gz`` (macOS)
- ``CertUtil -hashfile dist\scikit-image-*.tar.gz SHA256`` (Windows)
- Edit the file ``recipe/meta.yaml``:
- Update the version number on the first line.
- Update the SHA256 value on line 9.
- If necessary, reset the build number to 0. (line 12)
- Update any requirements in the appropriate sections (build or run).
Note: don't remove ``numpy x.x``. This tells conda-smithy, conda-forge's
build system, that the library must be linked against NumPy at build time.
- Commit these changes.
- Update the infrastructure around the recipe with ``conda-smithy``:
* Install conda-smithy either with conda or pip
* Run ``conda-smithy rerender`` in the root of the repository, and commit
the changes.
- Push to your fork, and submit a pull request to the
upstream repo.
Debian
------
The below instructions remain here for completeness. However, the Debian
scientific team has kindly taken over package maintenance. Simply follow the
procedure described at https://www.debian.org/Bugs/Reporting to report a "bug"
that there is a new version of scikit-image out (specifying the version
number), with severity set to "Wishlist".
If you want to take matters into your own hands for some reason, follow the
instructions detailed below to cut a Debian release yourself.
- Tag the release as per instructions above.
- git checkout debian
- git merge v0.x.x
- uscan <- not sure if this step is necessary
- Update changelog (emacs has a good mode, requires package dpkg-dev-el)
- C-C C-v add new version, C-c C-c timestamp / save
- git commit -m 'Changelog entry for 0.x.x'
- git-buildpackage -uc -us -rfakeroot
- Sign the changes: debsign skimage_0.x.x-x_amd64.changes
- cd ../build-area && dput mentors skimage_0.x.x-x_amd64.changes
- The package should now be available at:
http://mentors.debian.net/package/skimage
For the last lines above to work, you need ``~/.gbp.conf``::
[DEFAULT]
upstream-tag = %(version)s
[git-buildpackage]
sign-tags = True
export-dir = ../build-area/
tarball-dir = ../tarballs/
As well as ``~/dput.cf``::
[mentors]
fqdn = mentors.debian.net
incoming = /upload
method = http
allow_unsigned_uploads = 0
progress_indicator = 2
# Allow uploads for UNRELEASED packages
allowed_distributions = .*