Update CONTRIBUTING.md with release process

ideoforms · Nov 10, 2023 · aedbba8 · aedbba8
1 parent 7edc2a0
commit aedbba8
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -33,6 +33,22 @@ To run the unit test suite:
 python3 setup.py test
 ```
 
+## Release
+
+For each new release:
+
+- Update the version in `setup.py`
+- Add entry to `CHANGELOG.md`
+- Commit changes
+- Add a git version tag, in format `v1.2.34`
+- Add a GitHub release with title `v1.2.34`, using the latest `CHANGELOG` entry as the release body 
+- Build new wheels:
+  - Linux x86: wheels are automatically built using GitHub actions
+  - Linux rpi: wheels must be built manually using `auxiliary/cibuildwheel/make-raspberry-pi-aarch64.sh`
+  - macOS: wheels must be built manually using `auxiliary/cibuildwheel/make-macos-x86-arm64.sh`
+  - Windows: wheels must be built manually (TBC)
+- Upload wheels to pypi: `twine upload wheelhouse/1.2.34/*`
+
 ## Documentation
 
 To update autogenerated Node documentation: