Skip to content

RELEASING.rst

Latest commit

 

History

History
41 lines (24 loc) · 1.21 KB

RELEASING.rst

File metadata and controls

41 lines (24 loc) · 1.21 KB

Releasing pytest-xdist

This document describes the steps to make a new pytest-xdist release.

Version

master should always be green and a potential release candidate. pytest-xdist follows semantic versioning, so given that the current version is X.Y.Z, to find the next version number one needs to look at the changelog folder:

  • If there is any file named *.feature, then we must make a new minor release: next release will be X.Y+1.0.
  • Otherwise it is just a bug fix release: X.Y.Z+1.

Steps

To publish a new release X.Y.Z, the steps are as follows:

  1. Create a new branch named release-X.Y.Z from the latest master.

  2. Install tox in a virtualenv:

    $ pip install tox

  3. Update the necessary files with:

    $ tox -e release -- X.Y.Z

  4. Commit and push the branch to upstream and open a PR.

  5. Once the PR is green and approved, start the deploy workflow manually from the branch release-VERSION, passing VERSION as parameter, or execute:

    gh workflow run deploy.yml -R pytest-dev/pytest-xdist --ref release-X.Y.Z --field version=X.Y.Z

  6. Merge the release PR to master.