Skip to content

Latest commit

 

History

History
131 lines (78 loc) · 4 KB

release-checklist.rst

File metadata and controls

131 lines (78 loc) · 4 KB
Raw

Release Checklist

  1. Make sure correct version number is set in the following files (remove the ".devN" suffix):

    • datatest/__init__.py
    • docs/conf.py

  2. Make sure the description argument in setup.py matches the project description on GitHub (in the "About" section).

  3. In the call to setup(), check the versions defined by the python_requires argument (see the "Version specifiers" section of PEP-440 for details).

  4. In the call to setup(), check the trove classifiers in the classifiers argument (see https://pypi.org/classifiers/ for values).

  5. Check that packages argument of setup() is correct. Check that the value matches what setuptools.find_packages() returns:

    >>> import setuptools
>>> sorted(setuptools.find_packages('.', exclude=['tests']))

    Defining this list explicitly (rather than using find_packages() directly in setup.py file) is needed when installing on systems where setuptools is not available.

  6. Make sure __past__ sub-package includes a stub module for the current API version.

  7. Update README.rst (including "Backward Compatibility" section).

  8. Make final edits to CHANGELOG (doublecheck release date and version).

  9. Commit and push final changes to upstream repository:

    Prepare version info, README, and CHANGELOG for version N.N.N release.

  10. Perform final checks to make sure there are no CI test failures.

  11. Make sure the packaging tools are up-to-date:

    pip install -U twine wheel setuptools check-manifest

  12. Check the manifest against the project's root folder:

    check-manifest .

  13. Remove all existing files in the dist/ folder.

  14. Build new distributions:

    python setup.py sdist bdist_wheel

  15. Upload distributions to TestPyPI:

    twine upload --repository testpypi dist/*

  16. View the package's web page on TestPyPI and verify that the information is correct for the "Project links" and "Meta" sections:

    If you are testing a pre-release version, make sure to use the URL returned by twine in the previous step (the default URL shows the latest stable version).

  17. Test the installation process from TestPyPI:

    python -m pip install --index-url https://test.pypi.org/simple/ datatest

    If you're testing a pre-release version, make sure to use the "pip install" command listed at the top of the project's TestPyPI page.

  18. Upload source and wheel distributions to PyPI:

    twine upload dist/*

  19. Double check PyPI project page and test installation from PyPI:

    python -m pip install datatest

  20. Add version tag to upstream repository (also used by readthedocs.org).

  21. Iterate the version number in the development repository to the next anticipated release and add a "dev" suffix (e.g., N.N.N.dev1). This version number should conform to the "Version scheme" section of PEP-440. Make sure these changes are reflected in the following files:

    • datatest/__init__.py
    • docs/conf.py

    Commit these changes with a comment like the one below:

    Iterate version number to the next anticipated release.

    This is done so that installations made directly from the development repository and the "latest" docs are not confused with the just-published "stable" versions.

  22. Make sure the documentation reflects the new versions:

    If the documentation was not automatically updated, you may need to login to https://readthedocs.org/ and start the build process manually.

  23. Publish update announcement to relevant mailing lists: