summaryrefslogtreecommitdiff
path: root/RELEASING.rst
blob: e6e9d9e1ffe83a925435a2a62cc2764c3a38d495 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
Releasing WebTest
=================

- For clarity, we define releases as follows.

  - Alpha, beta, dev and similar statuses do not qualify whether a release is
    major or minor. The term "pre-release" means alpha, beta, or dev.

  - A release is final when it is no longer pre-release.

  - A *major* release is where the first number either before or after the
    first dot increases. Examples: 1.6 to 1.7a1, or 1.8 to 2.0.

  - A *minor* or *bug fix* release is where the number after the second dot
    increases. Example: 1.6 to 1.6.1.


Releasing with zest.releaser
----------------------------

- First install `zest.releaser <https://pypi.python.org/pypi/zest.releaser>`_::

    $ pip install zest.releaser[recommanded]

- Add this to your ``~/.pypirc``::

    [zest.releaser]
    no-input = true
    create-wheel = yes

- Edit ``CHANGELOG.rst``

- Run the fullrelease script::

    $ fullrelease

Marketing and communications
----------------------------

- Announce to Twitter::

    WebTest 3.0.x released.

    PyPI
    https://pypi.python.org/pypi/webtest/3.0.x

    Changes
    https://docs.pylonsproject.org/projects/webtest/en/latest/changelog.html

    Issues
    https://github.com/Pylons/webtest/issues

- Announce to maillist::

    WebTest 3.0.x has been released.

    Here are the changes:

    <<changes>>

    You can install it via PyPI:

      pip install WebTest==3.0.x

    Enjoy, and please report any issues you find to the issue tracker at
    https://github.com/Pylons/webtest/issues

    Thanks!

    - WebTest developers

Here is a command line to get those text without indent and version replaced::

    cat RELEASING.rst | sed 's/3.0.x/version/' | sed 's/    //'