-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c01f813
commit b0e87bb
Showing
1 changed file
with
18 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,58 +3,48 @@ | |
Release Checklist | ||
================= | ||
|
||
1. Check that *packages* argument of setup() is correct. Check with: | ||
|
||
>>> import setuptools | ||
>>> sorted(setuptools.find_packages('.', exclude=['tests'])) | ||
|
||
2. Make sure correct version number is set in the following files: | ||
1. Make sure correct version number is set in the following files: | ||
|
||
squint/__init__.py | ||
docs/conf.py | ||
|
||
3. Make sure __past__ sub-package includes a stub module for the | ||
current API version. | ||
|
||
4. Update README.rst (including "Backward Compatibility" section). | ||
|
||
5. Commit and push final changes to upstream repository: | ||
2. Commit and push final changes to upstream repository: | ||
|
||
Prepare version info, CHANGELOG, and README for version X.X.X release. | ||
|
||
6. Perform final checks to make sure there are no CI test failures. | ||
3. Perform final checks to make sure there are no CI test failures. | ||
|
||
7. Remove all existing files in the dist/ folder. | ||
4. Remove all existing files in the dist/ folder. | ||
|
||
8. Build new distributions: | ||
5. Build new distributions: | ||
|
||
python setup.py sdist bdist_wheel | ||
|
||
9. Upload source and wheel distributions to PyPI: | ||
6. Upload source and wheel distributions to PyPI: | ||
|
||
twine upload dist/* | ||
|
||
10. Double check PyPI project page and test installation from PyPI. | ||
7. Double check PyPI project page and test installation from PyPI. | ||
|
||
11. Add version tag to upstream repository (also used by readthedocs.org). | ||
8. Add version tag to upstream repository (also used by readthedocs.org). | ||
|
||
12. 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: | ||
9. 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 | ||
squint/__init__.py | ||
docs/conf.py | ||
|
||
Commit these changes with a comment like the one below: | ||
Commit these changes with a comment like the one below: | ||
|
||
Iterate version number to differentiate development version | ||
from latest release. | ||
Iterate version number to differentiate development version | ||
from latest release. | ||
|
||
13. Make sure the documentation reflects the new versions: | ||
10. Make sure the documentation reflects the new versions: | ||
|
||
* https://squint.readthedocs.io/ (stable) | ||
* https://squint.readthedocs.io/en/latest/ (latest) | ||
|
||
14. Publish update announcement to relevant mailing lists: | ||
11. Publish update announcement to relevant mailing lists: | ||
|
||
[email protected] |