Version Releases

This project follows the Semantic Versioning 2.0.0 style for code releases. This page describes the release process for a new framework version on the Project Github.

How to release

1. Once your PR(s) are merged, navigate to https://github.com/test-flare/pytest-flakefighters/releases, which can be found on the right hand side of the projects Github main page by clicking on ‘Releases’.

2. Press the Draft a new release button in the top right of the releases page.

3. Press the Choose a tag button and add the new version following the Semantic Version guidelines. Please include the ‘v’ before the tag, e.g. v0.0.0.

4. Enter the same tag name into the Release Title box.

5. Press Generate Release Notes button.

6. Add any additional information that may be helpful to the release notes. If there are breaking changes for example, which modules will they affect?

7. Ensure the Set as the latest release checkbox is selected.

8. Press publish release.

9. Check that the Github Action worker, found in the Actions tab has successfully completed. The typical time to publish to PyPI is around 2 minutes.

10. Check on the projects PyPI page that the latest release is ready!

From here the latest version can be installed using the common pip version commands. e.g. pip install pytest-flakefighters==0.0.0