diff --git a/docs/source/coredev/index.rst b/docs/source/coredev/index.rst index 91e3a1a..60f1cb0 100644 --- a/docs/source/coredev/index.rst +++ b/docs/source/coredev/index.rst @@ -58,6 +58,9 @@ During the release process, you might need the extra following dependencies: Make sure you have all the required dependencies to run the tests as well. +You can try to ``source tools/release_helper.sh`` when releasing via bash, it +should guide you through most of the process. + 1. Set Environment variables ---------------------------- diff --git a/tools/release_helper.sh b/tools/release_helper.sh new file mode 100644 index 0000000..67bb5d2 --- /dev/null +++ b/tools/release_helper.sh @@ -0,0 +1,35 @@ +# Simple tool to help for release +# when releasing with bash, simplei source it to get asked questions. + +echo -n PREV_RELEASE: +read PREV_RELEASE +echo -n MILESTONE: +read MILESTONE +echo -n VERSION: +read VERSION +echo -n branch: +read branch + +echo "updating what's new with informations from docs/source/whatsnew/pr" +python tools/update_whatsnew.py + +echo "here are all the authors that contributed to this release:" +git log --format="%aN <%aE>" $PREV_RELEASE... | sort -u -f + +echo "If you see any duplicates cancel (Ctrl-C), then edit .mailmap" Press enter to continue +read + +echo "generating stats" +python tools/github_stats.py --milestone $MILESTONE > stats.rst + +echo "stats.rst files generated. Please merge it with the right file (github-stats-X.rst)" +echo "press enter to continue." +read + +echo "Cleaning repository" +git clean -xfdi + +echo "please update version number in IPython/core/release.py" + +echo "Press enter to continue" +read