File tree Expand file tree Collapse file tree 1 file changed +37
-0
lines changed Expand file tree Collapse file tree 1 file changed +37
-0
lines changed Original file line number Diff line number Diff line change
1
+ =================
2
+ Releasing execnet
3
+ =================
4
+
5
+ This document describes the steps to make a new ``execnet `` release.
6
+
7
+ Version
8
+ -------
9
+
10
+ ``master `` should always be green and a potential release candidate. ``execnet `` follows
11
+ semantic versioning, so given that the current version is ``X.Y.Z ``, to find the next version number
12
+ one needs to look at the ``CHANGELOG.rst `` file:
13
+
14
+ - If there any new feature, then we must make a new **minor ** release: next
15
+ release will be ``X.Y+1.0 ``.
16
+
17
+ - Otherwise it is just a **bug fix ** release: ``X.Y.Z+1 ``.
18
+
19
+
20
+ Steps
21
+ -----
22
+
23
+ To publish a new release ``X.Y.Z ``, the steps are as follows:
24
+
25
+ #. Create a new branch named ``release-X.Y.Z `` from the latest ``master ``.
26
+
27
+ #. Update the ``CHANGELOG.rst `` file with the new release information.
28
+
29
+ #. Commit and push the branch for review.
30
+
31
+ #. Once PR is **green ** and **approved **, create and push a tag::
32
+
33
+ $ export VERSION=X.Y.Z
34
+ $ git tag v$VERSION release-$VERSION
35
+ $ git push [email protected] :pytest-dev/execnet.git v$VERSION
36
+
37
+ That will build the package and publish it on ``PyPI `` automatically.
You can’t perform that action at this time.
0 commit comments