Skip to content

Latest commit

 

History

History
19 lines (19 loc) · 1.49 KB

RELEASE.md

File metadata and controls

19 lines (19 loc) · 1.49 KB
Raw

Release Checklist

The following are the steps to follow to make a new PySCIPOpt release. They should mostly be done in order.

  • Check if scipoptsuite-deploy needs a new release, if a new SCIP version is released for example, or new dependencies (change symmetry dependency, add support for papilo/ parallelization.. etc). And Update release links in pyproject.toml
  • Check if the table in readme needs to be updated.
  • Update version number according to semantic versioning rules in _version.py. 
  • Update CHANGELOG.md; Change the Unlreased to the new version number and add an empty unreleased section.
  • Create a release candidate on test-pypi by running the workflow “Build wheels” in Actions->build wheels, with these parameters upload:true, test-pypi:true 
  • If the pipeline passes, test the released pip package on test-pypi by running and checking that it works
pip install -i https://test.pypi.org/simple/ PySCIPOpt
  • If it works, release on pypi.org with running the same workflow but with test-pypi:false.
  • Then create a tag wit the new version (from the master branch)
git tag vX.X.X
git push origin vX.X.X
  • Then make a github release from this new tag.
  • Update documentation by running the Generate Docs workflow in Actions->Generate Docs.