Release Instructions

Locally

1. Go to your local git installation of astrohack.
2. Checkout the main branch.
3. Merge the astrohack-dev branch onto main to bring in the latest developments.
4. Run the release script choosing the apropriate version bumping, minor (default), major or revision (Make sure to cleanup any notebook data before running this script so that notebook reflects actual user experience with downloads).
5. Push the changes to github if this was not done by the release script
6. Checkout the astrohack-dev branch and merge main onto it to bring the version bump to atrohack-dev.

Github

1. Create a new release from the astroHACK front page.
2. Choose the latest tag (the one with the recently bumped version number).
3. Add the exact same version number to the "Release Title".
4. Add a summary of latest developments to the release description.
5. Check the "Set as a pre-release" box at the bottom, beneath the attachments prompt.
6. Publish release.

Readthedocs

1. Go to the readthedocs page and navigate to the builds section in the bottom left corner of the page.

2. Look at the builds and be sure that the latest build is started and passing.

PYPI & Beyond

1. Check pypi to see that the latest version of thee code appears.

2. Lastly, run the stakeholder notebook hosted on google-colab to be sure there are no errors. This may fail due to problems with colab's implementation of matplotlib which not always compatible with astrohack.