Skip to content

Instantly share code, notes, and snippets.

@Cadair
Last active June 9, 2017 17:47
Show Gist options
  • Save Cadair/224b2d044ee45e80b589 to your computer and use it in GitHub Desktop.
Save Cadair/224b2d044ee45e80b589 to your computer and use it in GitHub Desktop.
SunPy Minor Release Checklist
  • Add a new heading for the next release in the CHANGELOG.md file.

  • Run the tests:

python setup.py test
  • Update version number in setup.py [don't commit yet]
  • Build the source distribution:
python setup.py sdist
  • Test that the sdist installs:
conda create -n sunpy-install python=2.7 numpy scipy astropy matplotlib pandas requests beautiful-soup scikit-image suds-jurko pytest sqlalchemy glymur wcsaxes

source activate sunpy-install

cd dist
tar -xvf sunpy-0.7.1.tar.gz
cd sunpy-0.7.1/
python setup.py install
  • Check that the sunpy.__version__ number is correct.
  • Run sunpy.self_test() to check that installed tests work
pip uninstall sunpy
deactivate
  • Commit the changes:
git add .
git commit -m "Release 0.1.1"
  • Push to the release branch on SunPy (the version number branch).
git push
< PR to release branch and merge >
  • Test that RTD is building the documentation correctly on release branch (and the version is correct).

  • Check that Travis is passing

  • Check that appveyor passes

  • Release on PyPI:

python setup.py register
python setup.py sdist upload
  • Test that it pip installs:
cd ~
workon pipsunpy
pip uninstall sunpy
pip install sunpy
  • Check sunpy imports, version is correct and self_test() passes
pip uninstall sunpy
deactivate
  • Tag the last git commit with the version number (use GitHub Releases)

Tag should be full version number preceeded by a v.

  • Update and make sure all builds of the sunpy/conda-package-build repo are complete, and the binaries are in binstar.

  • Enable the tag on RTD.

  • Push the code to the stable branch via PR

  • Send release announcement to mailing lists

  • Post release announcement on social media sites

  • Drink Beer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment