From aedbba88f88d42eb39b0badeb671f2523e8511ff Mon Sep 17 00:00:00 2001 From: Daniel Jones Date: Fri, 10 Nov 2023 21:44:27 +0000 Subject: [PATCH] Update CONTRIBUTING.md with release process --- CONTRIBUTING.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d77194e9..3faa5834 100644 --- 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: