Update README to include updates to release strategy (#221)

Co-authored-by: François Magimel <magimel.francois@gmail.com>
This commit is contained in:
Keith Bussell 2022-01-04 00:34:39 -08:00 committed by GitHub
parent 3dee9f1555
commit 620d716513
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -38,7 +38,5 @@ Releases
1. Make sure all tests on `master` are green.
2. Create a new branch `vX.Y.Z` from master for that specific release.
3. Bump versions in `setup.py` and `docs/source/conf.py` (docs have 2 places where the versions need to be changed!)
4. Pull request `vX.Y.Z` -> `stable`. Merging policy is very strict. This triggers a new release.
5. Pull request `stable` -> `master`. Now everything is back in sync.
Opening a pull request from `master` directly to `stable` is discouraged as `master` may be updated while the PR is open, thus changing the contents of the release.
4. Pull request `vX.Y.Z` -> `master`.
5. Pull request `master` -> `stable`. This merge triggers the deploy to pypi.