Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document release process #3094

Merged
merged 1 commit into from
Aug 18, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/development.rst
Expand Up @@ -213,6 +213,23 @@ maintainers.
`Porkbun <https://porkbun.com/>`_
-- reach out to him directly for any changes).

Creating a new release
~~~~~~~~~~~~~~~~~~~~~~

.. note::

The following process assumes that you call the ``remote`` for the main repository for tox ``upstream``.

.. code:: shell

git remote add upstream git@github.com:tox-dev/tox.git

In order to create a new release, a maintainer needs to run the following command::

tox r -e release -- <version>

You need to replace ``<version>`` with an actual version number according to
`Semantic Versioning <https://semver.org/>`_.

.. _current-maintainers:

Expand Down