Skip to content

Latest commit

 

History

History
60 lines (45 loc) · 1.36 KB

RELEASE.md

File metadata and controls

60 lines (45 loc) · 1.36 KB
Raw

PyPi

Preparation:

  • run unit tests: tests/mekatests/all_tests.py

  • increment version in setup.py

  • increment versions/copyright in doc/source/conf.py

  • increment CPU versions in doc/source/docker.rst (will be built later)

  • update API documentation

    • cd python/weka
    • sphinx-apidoc -f -o ../../doc/source .
    • make sure that all modules are included in index.rst (apart from modules.rst)

  • add new changelog section in CHANGES.rst

  • commit/push all changes

Commands for releasing on pypi.org (requires twine >= 1.8.0):

find -name "*~" -delete
rm dist/*
python3 setup.py clean
python3 setup.py sdist
twine upload dist/*

Commands for updating github pages (requires sphinx in venv and Java 8!):

find -name "*~" -delete
cd doc
make -e SPHINXBUILD=../venv/bin/sphinx-build clean
make -e SPHINXBUILD=../venv/bin/sphinx-build html
cd build/html
cp -R * ../../../../pymeka.gh-pages/
cd ../../../../pymeka.gh-pages/
git pull origin gh-pages
git add -A
git commit -a -m "updated documentation"
git rebase gh-pages
git push origin gh-pages
cd ../pymeka/
git pull

Github

Steps:

  • start new release (version: vX.Y.Z)
  • enter release notes, i.e., significant changes since last release
  • upload pymeka-X.Y.Z.tar.gz previously generated with setup.py
  • publish

Docker

Create new CPU docker image for this release and push it to docker hub.