Skip to content

Commit

Permalink
README: clarify release process
Browse files Browse the repository at this point in the history
  • Loading branch information
julianoes committed Jun 2, 2020
1 parent 4850254 commit 52dfd41
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,14 +107,26 @@ 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
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.

0 comments on commit 52dfd41

Please sign in to comment.