Skip to content

Commit 29b5e42

Browse files
authored
Document release process (#3094)
1 parent 2c4a745 commit 29b5e42

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/development.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,23 @@ maintainers.
213213
`Porkbun <https://porkbun.com/>`_
214214
-- reach out to him directly for any changes).
215215

216+
Creating a new release
217+
~~~~~~~~~~~~~~~~~~~~~~
218+
219+
.. note::
220+
221+
The following process assumes that you call the ``remote`` for the main repository for tox ``upstream``.
222+
223+
.. code:: shell
224+
225+
git remote add upstream [email protected]:tox-dev/tox.git
226+
227+
In order to create a new release, a maintainer needs to run the following command::
228+
229+
tox r -e release -- <version>
230+
231+
You need to replace ``<version>`` with an actual version number according to
232+
`Semantic Versioning <https://semver.org/>`_.
216233

217234
.. _current-maintainers:
218235

0 commit comments

Comments
 (0)