diff --git a/scripts/README.md b/scripts/README.md deleted file mode 100644 index 3ef5c77..0000000 --- a/scripts/README.md +++ /dev/null @@ -1,31 +0,0 @@ -# pomdp-py-release -Convenience for releasing pomdp_py - - -How to release pomdp-py: - -1. For each python version you'd like to support, starting from low to high, -2. activate the virtulenv for that python version -3. Run `./release.sh ` - - (note that if pomdp-py repo is assumed to be at `$HOME/repo/pomdp-py`. - - This should generate both wheel and source builds, - and place them under `pomdp-py/dist` properly. - -4. After you've generated the wheels for all the versions of your interest, - push to PyPI using twine: - - ``` - python3 -m twine upload --repository pypi dist/* - ``` - - -## Repository Convention (est. 07/25/23) - -* When you're executing a release, besides the steps above, you should always: - - 1. Merge the technical content of the `dev-` branch into `master`. - 2. Create a separate PR with all the docs updates. - - This makes it so that the contributions of external collaborators are correctly counted by github. Otherwise, the Sphinx html doc builds will count thousands of lines of changes to the collaborators which are incorrect.