Skip to content

Commit

Permalink
releasing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hawkowl committed Jun 15, 2016
1 parent c5caaac commit a8a731e
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/index.rst
Expand Up @@ -48,3 +48,4 @@ If you'd like to help out, here's some material to help you get started!
.. toctree::

contributing
release
18 changes: 18 additions & 0 deletions 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 <release> -m "Tag <release> release"``
#. Push up the tag using ``git push --tags``.

0 comments on commit a8a731e

Please sign in to comment.