Permalink
Browse files

Add CHECKLIST.

  • Loading branch information...
1 parent c07ea31 commit e4f4475b12f8aa1f1dc5242a30582444312e1d04 @donnemartin committed Dec 20, 2015
Showing with 89 additions and 0 deletions.
  1. +89 −0 CHECKLIST.md
View
@@ -0,0 +1,89 @@
+Release Checklist
+=================
+
+A. Install in a new venv and run unit tests
+
+Note, you can't seem to script the virtualenv calls, see:
+https://bitbucket.org/dhellmann/virtualenvwrapper/issues/219/cant-deactivate-active-virtualenv-from
+
+ $ deactivate
+ $ rmvirtualenv awesome
+ $ mkvirtualenv awesome
+ $ pip install -e .
+ $ pip install -r requirements-dev.txt
+ $ rm -rf .tox && tox
+
+B. Run code checks
+
+ $ scripts/run_code_checks.sh
+
+C. Run manual [smoke tests](#smoke-tests) on Mac, Ubuntu, Windows
+
+D. Update and review `README.rst` and `Sphinx` docs, then check awesome/docs/build/html/index.html
+
+ $ scripts/update_docs.sh
+
+E. Push changes
+
+F. Review Travis, Codecov, and Gemnasium
+
+G. Start a new release branch
+
+ $ git flow release start x.y.z
+
+H. Increment the version number in `awesome/__init__.py`
+
+I. Update and review `CHANGELOG.md`, then run:
+
+ $ scripts/create_changelog.sh
+
+J. Commit the changes
+
+K. Finish the release branch
+
+ $ git flow release finish 'x.y.z'
+
+L. Input a tag
+
+ $ vx.y.z
+
+M. Push tagged release to develop and master
+
+N. Set CHANGELOG as `README.md`
+
+ $ scripts/set_changelog_as_readme.sh
+
+O. Register package with PyPi
+
+ $ python setup.py register -r pypi
+
+P. Upload to PyPi
+
+ $ python setup.py sdist upload -r pypi
+
+Q. Upload Sphinx docs to PyPi
+
+ $ python setup.py upload_sphinx
+
+R. Restore `README.md`
+
+ $ scripts/set_changelog_as_readme_undo.sh
+
+S. Review newly released package from PyPi
+
+T. Release on GitHub: https://github.com/donnemartin/awesome/tags
+
+ 1. Click "Add release notes" for latest release
+ 2. Copy release notes from `CHANGELOG.md`
+ 3. Click "Publish release"
+
+U. Install in a new venv and run manual [smoke tests](#smoke-tests).
+
+## Smoke Tests
+
+Run the following on Python 2.7 and Python 3.4:
+
+* Create a new `virtualenv`
+* Pip install package into new `virtualenv`
+* Run package
+* Run targeted tests based on recent code changes

0 comments on commit e4f4475

Please sign in to comment.