-
Notifications
You must be signed in to change notification settings - Fork 13
How to release
ulfmueller edited this page Feb 1, 2018
·
17 revisions
- Start a reminder issue a few days before the release and label various issues to the release. Leave this issue open until the release is done and close it with a comment to inform the other developers.
- Test the examples and start in issue for non working examples.
- Use empty virtual environment e.g.
virtualenv etrago_env --clear -p python3.5
and install new version - Start documentation of release in doc/whatsnew/ v[X]_[Y].rst
- ...
- check setup.py and add new version no.
- Release via PyPI (if you don't have permissions for this repo, ask someone who does, e.g. @ulfmueller)
- The upload requires a
~/.pypirc
file with your PyPI credentials. Mind this: https://mail.python.org/pipermail/distutils-sig/2017-June/030766.html - Make sure you are in
master
branch. - Use
python3 setup.py sdist bdist_wheel
to create the distribution - use twine to upload the distribution by
twine upload dist/the_name_of_the_package
- The upload requires a
- In case of mayor changes of the files and folder structure create or update the doc/api files for ReadtheDocs by using
sphinx-apidoc -o api/ ../etrago/
- check import of packages and add in case
if not 'READTHEDOCS' in os.environ: import ...
- include new release massage /news file
doc/whatsnew/v[X]_[Y].rst
into/doc/whatsnew.rst
by adding.. include:: whatsnew/v[X]_[Y].rst
- add new version no. of release in doc/conf.py
- ...
Based on: How to release (oemof)