Add PR checklist and update RELEASE.md for automated workflow

Author: Joao-Dionisio

RELEASE.md

@@ -1,19 +1,36 @@
 # 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](https://github.com/scipopt/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](https://pyscipopt.readthedocs.io/en/latest/build.html#building-from-source) needs to be updated. 
-- [ ] Update version number according to semantic versioning [rules](https://semver.org/) 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
-```bash
-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 with the new version (from the master branch)
-```bash
-git tag vX.X.X
-git push origin vX.X.X
-```
-- [ ] Then make a github [release](https://github.com/scipopt/PySCIPOpt/releases/new) from this new tag. 
-- [ ] Update the documentation: from readthedocs.io -> Builds -> Build version (latest and stable)
+
+## Upgrading SCIP
+
+Run `./upgrade_scip.sh` from the `master` branch. The script will:
+1. Prompt for SCIP, SoPlex, GCG, and IPOPT versions
+2. Build new binaries via [scipoptsuite-deploy](https://github.com/scipopt/scipoptsuite-deploy) (skipped if a matching release already exists)
+3. Create a branch, update `pyproject.toml`, and open a PR
+
+On the PR:
+- [ ] Fix any API incompatibilities
+- [ ] Get CI green
+- [ ] Update the [compatibility table](https://pyscipopt.readthedocs.io/en/latest/build.html#building-from-source) if needed
+- [ ] Merge into `master`
+
+## Releasing PySCIPOpt
+
+Run `./release.sh` from the `master` branch. The script will:
+1. Prompt for the version bump type (patch/minor/major)
+2. Update `_version.py`, `setup.py`, and `CHANGELOG.md`
+3. Commit, tag, push, and trigger a test-pypi build
+
+After the script completes:
+- [ ] Test the package from test-pypi:
+  ```bash
+  pip install -i https://test.pypi.org/simple/ PySCIPOpt==X.Y.Z
+  ```
+- [ ] Release to production pypi:
+  ```bash
+  gh workflow run build_wheels.yml --repo scipopt/PySCIPOpt -f upload_to_pypi=true -f test_pypi=false
+  ```
+- [ ] Create a GitHub release:
+  ```bash
+  gh release create vX.Y.Z --repo scipopt/PySCIPOpt --title vX.Y.Z --generate-notes
+  ```
+- [ ] Update readthedocs: Builds -> Build version (latest and stable)

upgrade_scip.sh

@@ -205,9 +205,16 @@ git push -u origin "$BRANCH"
 
 gh pr create --repo "$REPO" \
     --title "Upgrade to SCIP ${SCIP_VERSION}" \
-    --body "Updates scipoptsuite-deploy ${CURRENT_DEPLOY_VERSION} -> ${NEW_DEPLOY_VERSION} (SCIP ${SCIP_VERSION}, SoPlex ${SOPLEX_VERSION}, GCG ${GCG_VERSION}, IPOPT ${IPOPT_VERSION}).
-
-Fix any API incompatibilities, get CI green, then merge and run \`./release.sh\`."
+    --body "$(cat <<EOF
+Updates scipoptsuite-deploy ${CURRENT_DEPLOY_VERSION} -> ${NEW_DEPLOY_VERSION} (SCIP ${SCIP_VERSION}, SoPlex ${SOPLEX_VERSION}, GCG ${GCG_VERSION}, IPOPT ${IPOPT_VERSION}).
+
+## Checklist
+- [ ] Fix any API incompatibilities
+- [ ] CI is green
+- [ ] Update [compatibility table](https://pyscipopt.readthedocs.io/en/latest/build.html#building-from-source) if needed
+- [ ] Merge and run \`./release.sh\`
+EOF
+)"
 
 echo ""
 echo "Done! PR created on branch '${BRANCH}'."