diff --git a/docs/source/index.rst b/docs/source/index.rst index adc555efac..285c1f9c8f 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -80,6 +80,7 @@ Vital statistics: design.rst history.rst contributing.rst + releasing.rst code-of-conduct.rst ==================== diff --git a/docs/source/releasing.rst b/docs/source/releasing.rst new file mode 100644 index 0000000000..ff17c84829 --- /dev/null +++ b/docs/source/releasing.rst @@ -0,0 +1,65 @@ +.. _releasing: + + +Things to do for releasing: + +* announce intent to release on gitter + +* check for open issues / pull requests that really should be in the release + + + come back when these are done + + + … or ignore them and do another release next week + +* check for deprecations "long enough ago" (two months or two releases, whichever is longer) + + + remove affected code + +* Do the actual release changeset + + + update version number + + - increment as per Semantic Versioning rules + + - remove ``+dev`` tag from version number + + + Run ``towncrier`` + + - review history change + + - ``git rm`` changes + + + commit + +* push to your personal repository, "release" branch + +* create pull request to ``python-trio/trio``'s "release" branch + +* announce PR on gitter + + + wait for feedback + + + fix problems, if any + +* verify that all checks succeeded + +* acknowledge the release PR + + + or rather, somebody else should do that + +* tag with vVERSION + +* push to PyPI + + + ``python3 setup.py sdist bdist_wheel upload`` + +* announce on gitter + +* update version number + + + add ``+dev`` tag to the end + +* prepare pull request from "release" back to "master" + + + acknowledge it +