Skip to content

Commit 1a4e308

Browse files
authored
update HOWTORELEASE.rst (#126)
* elaborate on releasing steps * add testenv:release to tox.ini * remove unnecessary command * remove virtual env creation * remove .vscode and add it to .gitignore * remove testenv:release from tox.ini
1 parent ad1ccb7 commit 1a4e308

File tree

2 files changed

+29
-7
lines changed

2 files changed

+29
-7
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*.egg-info
44
build
55
sdist
6-
6+
.vscode
77
__pycache__/
88

99
# virtualenv

HOWTORELEASE.rst

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,29 @@
1-
Here are the steps on how to make a new release.
1+
=======================
2+
Releasing pytest-flask
3+
=======================
24

3-
1. Create a ``release-VERSION`` branch from ``upstream/master``.
4-
2. Update ``docs/changelog.rst``.
5-
3. Push a branch with the changes.
6-
4. Once all builds pass, push a tag to ``upstream``.
7-
5. Merge the PR.
5+
This document describes the steps to make a new ``pytest-flask`` release.
6+
7+
Version
8+
-------
9+
10+
``master`` should always be green and a potential release candidate. ``pytest-flask`` 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 ``docs/changelog.rst`` file.
13+
14+
Steps
15+
-----
16+
17+
#. Create a new branch named ``release-X.Y.Z`` from the latest ``master``.
18+
19+
#. After making the necessary changes, commit and push the branch for review.
20+
21+
#. Once PR is **green** and **approved**, create and push a tag::
22+
23+
$ export VERSION=X.Y.Z
24+
$ git tag $VERSION release-$VERSION
25+
$ git push [email protected]:pytest-dev/pytest-flask.git $VERSION
26+
27+
That will build the package and publish it on ``PyPI`` automatically.
28+
29+
#. Merge ``release-X.Y.Z`` branch into master.

0 commit comments

Comments
 (0)