From a8a731ed4b66ef73d913cec15011be0d5f5e6a94 Mon Sep 17 00:00:00 2001 From: "Amber Brown (HawkOwl)" Date: Wed, 15 Jun 2016 14:44:00 +0800 Subject: [PATCH] releasing docs --- docs/index.rst | 1 + docs/release.rst | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+) create mode 100644 docs/release.rst diff --git a/docs/index.rst b/docs/index.rst index d8a49f55c..95b52d721 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -48,3 +48,4 @@ If you'd like to help out, here's some material to help you get started! .. toctree:: contributing + release diff --git a/docs/release.rst b/docs/release.rst new file mode 100644 index 000000000..37f148cc4 --- /dev/null +++ b/docs/release.rst @@ -0,0 +1,18 @@ +=============== +Releasing Klein +=============== + +Klein is released on a time-dependent basis, similar to Twisted. + +Each version is numbered with the major portion being the last two digits of the year, and the minor portion being the zero-indexed release number. +That is, the first release of 2016 would be 16.0, and the second would be 16.1. + + +Doing a Release +--------------- + +#. Clear the directory of any other changes using ``git clean -f -x -d .`` +#. Generate the tarball and wheel using ``python setup.py sdist bdist_wheel``. +#. Upload the tarball and wheel using ``twine upload dist/klein-*``. +#. Tag the release using ``git tag -s -m "Tag release"`` +#. Push up the tag using ``git push --tags``.