Skip to content

Commit 41fba41

Browse files
authored
Update README.rst
1 parent 39386a3 commit 41fba41

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,22 @@ This code is published under the MIT license. See the
5959
`LICENSE <https://github.com/Turbo87/aerofiles/blob/master/LICENSE>`__ file
6060
for the full text.
6161

62+
How to release
63+
--------------
64+
65+
Make sure, that all tests succeed and CHANGELOG.rst is up to date
66+
including the (next) version number.
67+
68+
Use browser with https://github.com/Turbo87/aerofiles/releases and
69+
"Draft a new release". Use "Choose a tag" to create a new tag
70+
following the structure "v1.2.1". The release title should be
71+
"aerofiles v1.2.1". Use text from CHANGELOG.rst to describe this
72+
release.
73+
74+
Finally use "Set as the latest release" and publish release.
75+
76+
Then go to https://readthedocs.org/projects/aerofiles/ and hit
77+
"Build-Version" to update the documentation from github.com.
6278

6379
.. |aerofiles| image:: https://github.com/Turbo87/aerofiles/raw/master/img/logo.png
6480
:alt: aerofiles

0 commit comments

Comments
 (0)