From 52dfd412d20a4e17fa871cf8afccb77ee1e84867 Mon Sep 17 00:00:00 2001 From: Julian Oes Date: Tue, 2 Jun 2020 08:30:38 +0200 Subject: [PATCH] README: clarify release process --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 76dc1818..98754a11 100644 --- a/README.md +++ b/README.md @@ -107,7 +107,7 @@ Note: MAVDSK-Python runs `mavsdk/bin/mavsdk_server` when `await drone.connect()` ### Generate the API documentation -Make sure the version is set correctly before generating and uploading new documentation. +Make sure the version tag is set correctly before generating new documentation. ``` pip3 install sphinx numpydoc @@ -115,6 +115,18 @@ make -C mavsdk html ``` -### Release to PyPi repository +### Release steps -The CI will create and push a wheel for Windows, Linux and macOS to PyPi whenever a tag is pushed and a release created. +1. Check all required pull requests are merged to master +2. Check [MAVSDK_SERVER_VERSION](MAVSDK_SERVER_VERSION) is set to the correct version of mavsdk_server. +3. Create git tag on laster master, e.g.: + ``` + git switch master + git pull + git tag X.Y.Z + git push --tags + ``` +4. Go to [releases page](https://github.com/mavlink/MAVSDK-Python/releases) and create new release. + The CI will now: + - Create and push a wheel for Windows, Linux and macOS to PyPi. + - Generate the latest docs and push them to s3.