-
Notifications
You must be signed in to change notification settings - Fork 0
/
release-checklist.txt
47 lines (27 loc) · 1.33 KB
/
release-checklist.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
=================
Release Checklist
=================
1. Make sure correct version number is set in the get_reader.py file.
2. Make sure the description argument in setup.py matches the project
description on GitHub.
3. Update README.md and CHANGELOG files as appropriate.
4. Commit and push final changes to upstream repository:
Prepare version info, CHANGELOG, and README for version X.X.X release.
5. Perform final checks to make sure there are no test failures.
6. Remove all existing files in the dist/ folder.
7. Make sure the packaging tools are up-to-date:
pip install -U twine wheel setuptools
8. Build new distributions:
python setup.py sdist bdist_wheel
9. Upload source and wheel distributions to PyPI:
twine upload dist/*
10. Double check PyPI project page and test installation from PyPI.
11. Add version tag to upstream repository (also used by readthedocs.org).
12. Iterate version number in get_reader.py indicating that it is a development
version (e.g., X.X.X.dev0) so that "latest" docs aren't confused with the
just-published "stable" docs.
Commit this change with a comment like the one below:
Iterate version number to differentiate development version
from latest release.
13. Publish update announcement to relevant mailing lists: