-
Notifications
You must be signed in to change notification settings - Fork 145
/
RELEASING.txt
103 lines (63 loc) · 2.47 KB
/
RELEASING.txt
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
Releasing
=========
- 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.0 to 1.1a1, or 0.9 to 1.0.
- A *minor* or *bug fix* release is where the number after the second dot
increases. Example: 1.0 to 1.0.1.
Prepare new release
-------------------
- Do platform test via tox:
$ tox -r
Make sure statement coverage is at 100% (the test run will fail if not).
- Run tests on Windows if feasible.
- Ensure all features of the release are documented (audit CHANGES.rst or
communicate with contributors).
- Change CHANGES.rst heading to reflect the new version number.
- Minor releases should include a link under "Bug Fix Releases" to the minor
feature changes in CHANGES.rst.
- Change setup.py version to the release version number.
- Make sure PyPI long description renders (requires ``readme_renderer``
installed into your Python)::
$ python setup.py check -r -s -m
- Create a release tag.
- Make sure your Python has ``setuptools-git``, ``twine``, and ``wheel``
installed and release to PyPI::
$ python setup.py sdist bdist_wheel
$ twine upload dist/colander-X.X-*
Prepare "main" for further development (major releases only)
------------------------------------------------------------
- In CHANGES.rst, preserve headings but clear out content. Add heading
"unreleased" for the version number.
- Change setup.py version to the next version number.
Marketing and communications
----------------------------
- Announce to Twitter.
```
colander 2.x released.
PyPI
https://pypi.org/project/colander/2.x/
Changes
https://docs.pylonsproject.org/projects/colander/en/latest/changes.html
Documentation:
https://docs.pylonsproject.org/projects/colander/en/latest/
Issues
https://github.com/Pylons/colander/issues
```
- Announce to maillist.
```
colander 2.X.X has been released.
The full changelog is here:
https://docs.pylonsproject.org/projects/colander/en/latest/changes.html
Documentation:
https://docs.pylonsproject.org/projects/colander/en/latest/
You can install it via PyPI:
pip install colander==2.X
Enjoy, and please report any issues you find to the issue tracker at
https://github.com/Pylons/colander/issues
Thanks!
- colander core developers
```