-
Notifications
You must be signed in to change notification settings - Fork 31
/
release_checklist
25 lines (24 loc) · 1.81 KB
/
release_checklist
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
* Create a release branch from develop. (Only bugfixes in release branch)
* Grep code for "DEPRECATED", "DeprecationWarning" and similar words
and remove remaining deprecated code. (`grep -r -i Depreca forgi test examples`)
* grep for log.warning, log.error and warnings.warn and reevaluate if this warning is needed. (If an error will be raised, use log_to_exception for logging of level error)
* Increment version number in setup.py, __init__.py, doc/conf.py (2 times) and in doc/index.rst
* Run nosetests
* Update api-documentation to include all (new) modules and subpackages. (venv/bin/sphinx-apidoc -o tempdir forgi --separate) followed by comparing and manually merging tempdir with doc/apidoc
* Build the documentation (`venv/bin/sphinx-build -a -E -W -b html doc compiledDoc` to build it)
Check all warnings during building of documentation
* Make sure all authors of code parts are properly acknowledged and their license is compatible
* Perform code-analysis with pylint forgi/ --ignore=_k2n_standalone,average_atom_positions.py,average_atom_positions_sorted.py,average_stem_vres_atom_positions.py -f json -j 6 | pylint-json2html -o pylint.html
* Verify all issues on github are solved
* Check whether example scripts still work
* Update setup.py to include all relevant subpackages and scripts
* Check test coverage. Add tests if required.
* Find dead code with `venv/bin/vulture forgi/ examples/ test/ ../ernwin/fess/ | less`, but manually check the results (vulture reports false positives)
* Verify that the travis build passes
* Write a change log to document API changes
* Rebuild the documentation
* Run nosetests again.
* Merge into master and develop
* Tag inside master
* Publish documentation to gh-pages
* Upload to pypi: python setup.py sdist bdist_wheel; gpg2 --detach-sign -a dist/forgi-N.N*; twine upload dist/forgi-N.N*