Skip to content

Conversation

Joao-Dionisio
Copy link
Member

@Joao-Dionisio Joao-Dionisio commented May 6, 2025

First time doing this, bear with me.

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 the documentation needs to be updated.
  • Update version number according to semantic versioning rules in src/pyscipopt/_version.py and setup.py
  • Update CHANGELOG.md; Change the Unreleased 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 the documentation: from readthedocs.io -> Builds -> Build version (latest and stable)

@DominikKamp
Copy link
Contributor

Could #988 be added in the release? Otherwise, it still does not work for me.

@Joao-Dionisio
Copy link
Member Author

For some info, pip install -i https://test.pypi.org/simple/ PySCIPOpt on my machine is installing v5.3.0.

With pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ PySCIPOpt==5.5.0 I get the correct version, but I worry that this is indicative that something went wrong. Waiting for some input before continuing.

@Joao-Dionisio
Copy link
Member Author

I didn't really do anything, but now it's installing the correct version.

@Joao-Dionisio Joao-Dionisio marked this pull request as ready for review May 10, 2025 10:43
@Joao-Dionisio Joao-Dionisio merged commit 0b78317 into master May 10, 2025
16 checks passed
@DominikKamp
Copy link
Contributor

Works, thank you!

@Joao-Dionisio Joao-Dionisio deleted the release-5.5.1 branch August 7, 2025 09:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants