How to create a new release of PAYNT

How to create a new release of PAYNT

This page serves as a tutorial and reminder for the maintainers of PAYNT on how to create releases.

After the master branch reaches a point where we want to make a new release and all of the CI workflows are green, follow these steps to create a new release of PAYNT:

1. run the Prepare PAYNT release workflow, targeting master branch and setting the desired PAYNT version and the stormpy version you want to be compatible with

2. workflow from step 1 creates a release branch and a PR that merges the needed changes to master, after you check everything is okay merge the PR

3. publish a release, creating a new tag vX.Y.Z for version X.Y.Z on master

   a) use this release message template:

   Requires **stormpy==1.13.2**
   
   - change 1
   - change 2...
   
   **Full Changelog**: https://github.com/randriu/synthesis/compare/v0.4.0...v0.4.1
   

4. after the release workflow finishes and the release is uploaded to pypi, PR unpinning the stormpy dependency will be created and needs to be merged for development

5. also after the release, we can remove all of the branches used for the release and pre-release versions

Creating a test release

If you want to test building wheels you can run the workflow Test building wheel and upload to TestPyPI manually from the Actions page.

Note that if you want to create non-release wheels, for example, when you want to share a new version of PAYNT with a user, you can run the Build wheels workflow.