Skip to content

Release checklist

Jump to bottom
Nicolas Papernot edited this page Nov 21, 2018 · 10 revisions

Release checklist (WIP)

This checklist should be followed when releasing a new version of CleverHans:

  • Ensure that no outstanding issues need to be addressed (e.g., bugs that may impact benchmarks)
  • Update README.md to reflect new version number and updated list of authors
  • Update setup.py to reflect new version number (pre-requisite for pypi step)
  • Update cleverhans/__init__.py to reflect new version number
  • Create new version on GitHub with summary of important changes with respect to last version
  • Update pypi: before uploading the package to pypi, check that pip install path/to/dist/cleverhans-X.Y.Z.tar.gz returns the right version number once imported because pypi does not allow overwriting versions, see instructions here: https://packaging.python.org/tutorials/packaging-projects/
  • Update the arXiv technical report and its citation on the library's README.md
Clone this wiki locally