release-checklist.rst

Release checklist

Things to remember when making a new release of pandas-validation.

1. Changes should be made to some branch other than master (a pull request should then be created before making the release).

2. Make desirable changes to the code.

3. Check coding style against some of the conventions in PEP8:

   $ pycodestyle *.py
   

4. Run tests and report coverage:

   $ pytest -v test_pandasvalidation.py
   $ coverage run -m pytest test_pandasvalidation.py
   $ coverage report -m pandasvalidation.py
   

5. Update README.rst and the documentation (in docs/).

   $ sphinx-build -b html ./docs/source ./docs/_build/html
   

6. Update CHANGELOG.rst and add a release date.

7. Update the release (version) number in setup.py and pandasvalidation.py. Use Semantic Versioning.

8. Create pull request(s) with changes for the new release.

9. Create distributions and upload the files to PyPI with twine.

   $ python setup.py sdist bdist_wheel --universal
   $ twine upload dist/*
   

10. Create the new release in GitHub.

11. Trigger a new build (latest version) of the documentation on http://readthedocs.io.