diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md index ad43f756..37795611 100644 --- a/.github/ISSUE_TEMPLATE/release.md +++ b/.github/ISSUE_TEMPLATE/release.md @@ -21,15 +21,15 @@ _to be written during release process_ - [ ] Write Changelog in PR and request review - [ ] Review the PR (if OK - merge, but DO NOT delete the branch) - [ ] Minimize packages in requirements.txt and conda-forge submission. Update packages in setup.py -- [ ] Check unit tests -> Check all tests pass and there are tests for all important features (go to cmder, activate TQ, go to tests folder, type "pytest" and run) +- [ ] Check unit tests -> Check all tests pass on CPU and [GPU (e.g. on colab)](https://colab.research.google.com/drive/1lFpdtY5zV7VpW88aazedA3n4khedHDQP?usp=sharing#scrollTo=IbU2vypPQ-Ej) and that there are tests for all important features - [ ] Check documentation -> Check presence of documentation for all features by locally building the docs on the release - [ ] Change version number in setup.py and docs (under conf.py) - [ ] Trigger the Upload Python Package to testpypi GitHub Action (https://github.com/esa/torchquad/actions/workflows/deploy_to_test_pypi.yml) on the release branch (need to be logged in) - [ ] Test the build on testpypi (with `pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple torchquad`) - [ ] Finalize release on the release branch -- [ ] Create PR: release → main , develop -> main -- [ ] PR Reviews -- [ ] Merge release back into main, and develop +- [ ] Create PR: `release` → `main`, `release` -> `develop` +- [ ] PR Review +- [ ] Merge `release` back into `main`, and `develop` - [ ] Create Release on GitHub from the last commit (the one reviewed in the PR) reviewed - [ ] Upload to PyPI - [ ] Update on conda following https://conda-forge.org/docs/maintainer/updating_pkgs.html