# ironArray (Python) release procedure ## Preliminaries * Make sure that the current develop branch is passing the tests on Azure pipelines. * Make sure that `RELEASE-NOTES.md` and `ANNOUNCE.md` are up-to-date with the latest news in the release. ### Keep track of possible regressions * Re-run tutorials and benchmarks in the `iron-array-notebooks` submodule. This includes the benchmarks in `iron-array-notebooks/perf-history`. Change first to the submodule and update it to the latest version: ``` cd iron-array-notebooks/ git switch main git pull ``` * Fix any possible change in the API or possible performance or memory consumption regressions you may detect. * After completion, add the new `iron-array-notebooks/perf-history/perf-history.csv` file to the `iron-array-notebooks` repo: ``` git commit perf-history/perf-history.csv -m "Getting ready for release X.Y.Z" git push ``` * Push a tag in `iron-array-notebooks` so that the `.csv` file is renamed according to the tag in the `iron-array-notebooks`. The tag does not have to be the same as in `iron-array-python`. ``` git tag -a vX.Y.Z -m "Tagging version X.Y.Z" git push --tags ``` ### Regenerate docs * Use this for generating docs: ``` cd doc PYTHONPATH=.. make html ``` * Create tar and check that everything is fine: ``` cd build tar cvfz /tmp/html-docs.tar.gz html tar xfvz html-docs.tar.gz open html/index.html ``` * Go to https://ironarray.io:2083 and then to `public_html/docs/` and: * Remove `html.bck` dir. * Move `html` dir to `html.bck`. * Go home and extract the html doc tarball to `public_html/docs`. * Finally, go check that new docs in https://ironarray.io/docs/html/ are correct. ### Update the version and commit * Go back to the top repo and check that `__version__` in `iarray/__init__.py` file contains the correct number. ``` cd .. cat iarray/__init__.py ``` * Commit the changes: ``` git commit -a -m "Getting ready for release X.Y.Z" git push ``` ## Tagging * Create a (signed) tag ``X.Y.Z`` from ``develop``. Use the next message: ``` git tag -a vX.Y.Z -m "Tagging version X.Y.Z" ``` * Push the tag to the github repo: ``` git push git push --tags ``` After the tag would be up, update the release notes in: https://github.com/ironArray/ironArray-support/releases * Check that the wheels have been uploaded correctly to our PyPi server (distribution-ssh.ironarray.io). * Test that the wheels can be correctly installed: ``` pip install --index-url https://distribution.ironarray.io:443/simple iarray -U --force ``` ## Announcing * Send an announcement to the ironArray mailing list. Use the ``ANNOUNCE.rst`` file as skeleton (or possibly as the definitive version). * Announce in Twitter via @ironArray account and rejoice. ## Post-release actions * Create new headers for adding new features in ``RELEASE-NOTES.md`` add this place-holder: ``` XXX version-specific blurb XXX ``` * Edit ``VERSION`` in develop to increment the version to the next minor one (i.e. X.Y.Z --> X.Y.(Z+1).dev0). * Commit your changes with: git commit -a -m "Post X.Y.Z release actions done" git push That's all folks!