Skip to content

Guide to Making A Release

Jump to bottom
Marshall Perrin edited this page Dec 13, 2018 · 12 revisions

This can probably be streamlined and automated...

Steps to follow:

  1. Pre-release checklist. Ensure the release notes have what you want in them, ensure all the issues you want closed are closed, all the relevant PRs are merged, check all the tests pass, etc.

    1. If updating the webbpsf data files, do that using the scripts in webbpsf/dev_utils/master_data_release.sh.
    2. Unzip the resulting zip file someplace. Manually set $WEBBPSF_DATA_PATH to that. Test that stuff works.
    3. Update webbpsf/__init__.py to set DATA_VERSION_MIN to that version.

  2. Optional: Create release branch and get ready to release, following http://nvie.com/posts/a-successful-git-branching-model/

    1. Dec 2018 update: I think this is an outdated idea and not necessary right now? We haven’t so far been keeping persistent open branches for each version.

  3. Do the following:

    1. git pull # ensure you have latest master!
    2. Update version numbers
      1. in setup.py
      2. for webbpsf, in the data file download URLs in docs/installation.rst
      3. PROBABLY UPDATE WEBBPSF’s setup.py TO DEPEND ON LATEST POPPY RELEASE TOO
    3. python setup.py clean

  4. python setup.py sdist

    1. This makes the ‘sdist’ zip file that will be uploaded to PyPI

  5. Test installing from that file and make sure it works

    1. cd dist
    2. pip install <name of dist file>
    3. python
    4. >>> import poppy
    5. >>> poppy.__path__, poppy.__version__ # check these are as desired
    6. >>> poppy.test() # checks functionality of the installed package
    7. cd ..

  6. Tag the release in git:

    1. git commit -m “Release 1.2.3"
    2. git tag -a “v1.2.3"
    3. git push
    4. git push —tags
    5. Add a release via the Github web interface. See https://help.github.com/articles/creating-releases/

  7. Update PyPI

    1. You need to have accounts on both PyPI and TestPyPI. Register there if you haven't already. An owner (admin) of webbpsf and poppy will need to add you to the list of maintainers there.
    2. Ensure you have twine installed and set up. See https://pypi.org/project/twine/
    3. Upload a test file to TestPYPI: twine upload --repository-url https://test.pypi.org/legacy/ dist/*
    4. Look at test.pypi.org and verify things seem ok.
    5. Assuming they are, twine upload dist/*

  8. Readthedocs should automatically build the latest docs from the push to GitHub. But verify this has taken place, and if necessary kick off a manual build.

  9. For the astroconda-contrib repository, submit a PR updating the poppy, webbpsf, and webbpsf-data versions appropriately

    1. https://github.com/astroconda/astroconda-contrib/tree/master/webbpsf etc
Clone this wiki locally