Skip to content

How to release

nesnoj edited this page May 28, 2021 · 8 revisions

OUTDATED! See example from oemof

  1. Checkout dev
  2. Re-Check setup.py
    1. Set version no. if not already happened
    2. Check if (upper limit of) versions of required packages are up-to-date (you may test your package with the latest versions and update accordingly)
    3. Update CHANGELOG.md, make sure version and date is correct. Note: Always keep a section [Unreleased] at top of the release list.
  3. Create release branch in the format release/vX.Y.Z from dev
  4. Create pull request (to master)
  5. Merge or let someone else merge it
  6. Create a release tag on master
  7. Release via PyPI (if you don't have permissions for this repo, ask someone who does)
    1. The upload requires a ~/.pypirc file with your PyPI credentials.
    2. Make sure you are in master branch.
    3. Use python3 setup.py register sdist upload to register and upload package to PyPI.
  8. Merge master into dev
  9. Adjust setup.py of dev: Set new version no. for next release (in case it's already defined)
Clone this wiki locally