RELEASING.md

Pyoozie Release Instructions

To release a new version of pyoozie:

1. Create a user account at PyPI and Test PyPI

2. Ask a project maintainer (e.g. cfournie) for access to pyoozie

3. Setup your local ~/.pypirc with your credentials:

   [distutils]
   index-servers=
       pypi
       testpypi
   
   [testpypi]
   repository = https://test.pypi.org/legacy/
   username = <your user name goes here>
   password = <your password goes here>
   
   [pypi]
   repository = https://upload.pypi.org/legacy/
   username = <your user name goes here>
   password = <your password goes here>
   

4. Merge a PR that increments __version__ according to our versioning standards that lists the features associated with this release (e.g. this release PR)

   • Note that this PR does not necessarily need to be merged to master but should be code reviewed
   • Also note that a release does not have to be crafted from current master but could branch off and cherry pick specific features to release

5. Check out the latest version of the master branch (unless you have a good reason to release off of master) and run make install to set up dev tools

6. Optionally run python setup.py register -r https://test.pypi.org/legacy/ if the project has been deleted on Test PyPI

7. Run make release to build the release files locally

8. Run make upload_test to upload the release to Test PyPI

9. Test that the release works by running pip install -i https://testpypi.python.org/pypi pyoozie in a fresh virtualenv and make sure that:

   • It installs correctly (you may need to manually install its dependencies b/c they probably aren't on Test PyPI); and
   • You can at least import a class/function from the library

10. If everything looks OK, release to PyPI by running make upload_pypi