-
Notifications
You must be signed in to change notification settings - Fork 0
/
release_checklist.txt
55 lines (31 loc) · 1.46 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
48
49
50
51
52
53
54
55
Release Checklist
-----------------
1. Make sure correct version number is set in the following files:
squint/__init__.py
docs/conf.py
2. Make sure the description argument in setup.py matches the project
description on GitHub.
3. Commit and push final changes to upstream repository:
Prepare version info, CHANGELOG, and README for version X.X.X release.
4. Perform final checks to make sure there are no CI/tox test failures.
5. Make sure the packaging tools are up-to-date:
pip install -U twine wheel setuptools
6. Remove all existing files in the dist/ folder.
7. Build new distributions:
python setup.py sdist bdist_wheel
8. Upload source and wheel distributions to PyPI:
twine upload dist/*
9. Double check PyPI project page and test installation from PyPI.
10. Add version tag to upstream repository (also used by readthedocs.org).
11. Iterate version number in repository 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:
squint/__init__.py
docs/conf.py
Commit these changes with a message like the one below:
Iterate version number in development repository.
12. Make sure the documentation reflects the new versions:
* https://squint.readthedocs.io/ (stable)
* https://squint.readthedocs.io/en/latest/ (latest)
13. Publish update announcement to relevant mailing lists: