Skip to content

Latest commit

 

History

History
65 lines (39 loc) · 2.16 KB

HOWTORELEASE.rst

File metadata and controls

65 lines (39 loc) · 2.16 KB
Raw

Release Procedure

Our current policy for releasing is to aim for a bugfix every few weeks and a minor release every 2-3 months. The idea is to get fixes and new features out instead of trying to cram a ton of features into a release and by consequence taking a lot of time to make a new one.

Important

pytest releases must be prepared on Linux because the docs and examples expect to be executed in that platform.

  1. Install development dependencies in a virtual environment with:

    pip3 install -r tasks/requirements.txt

  2. Create a branch release-X.Y.Z with the version for the release.

    • patch releases: from the latest master;
    • minor releases: from the latest features; then merge with the latest master;

    Ensure your are in a clean work tree.

  3. Generate docs, changelog, announcements and upload a package to your devpi staging server:

    invoke generate.pre-release <VERSION> <DEVPI USER> --password <DEVPI PASSWORD>

    If --password is not given, it is assumed the user is already logged in devpi. If you don't have an account, please ask for one.

  4. Open a PR for this branch targeting master.

  5. Test the package

    • Manual method

      Run from multiple machines:

      devpi use https://devpi.net/USER/dev
devpi test pytest==VERSION

      Check that tests pass for relevant combinations with:

      devpi list pytest

    • CI servers

      Configure a repository as per-instructions on devpi-cloud-test to test the package on Travis and AppVeyor. All test environments should pass.

  6. Publish to PyPI:

    invoke generate.publish-release <VERSION> <DEVPI USER> <PYPI_NAME>

    where PYPI_NAME is the name of pypi.python.org as configured in your ~/.pypirc file for devpi.

  7. After a minor/major release, merge release-X.Y.Z into master and push (or open a PR).