Skip to content

Commit 52dfd41

Browse files
committed
README: clarify release process
1 parent 4850254 commit 52dfd41

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,14 +107,26 @@ Note: MAVDSK-Python runs `mavsdk/bin/mavsdk_server` when `await drone.connect()`
107107

108108
### Generate the API documentation
109109

110-
Make sure the version is set correctly before generating and uploading new documentation.
110+
Make sure the version tag is set correctly before generating new documentation.
111111

112112
```
113113
pip3 install sphinx numpydoc
114114
make -C mavsdk html
115115
```
116116

117117

118-
### Release to PyPi repository
118+
### Release steps
119119

120-
The CI will create and push a wheel for Windows, Linux and macOS to PyPi whenever a tag is pushed and a release created.
120+
1. Check all required pull requests are merged to master
121+
2. Check [MAVSDK_SERVER_VERSION](MAVSDK_SERVER_VERSION) is set to the correct version of mavsdk_server.
122+
3. Create git tag on laster master, e.g.:
123+
```
124+
git switch master
125+
git pull
126+
git tag X.Y.Z
127+
git push --tags
128+
```
129+
4. Go to [releases page](https://github.com/mavlink/MAVSDK-Python/releases) and create new release.
130+
The CI will now:
131+
- Create and push a wheel for Windows, Linux and macOS to PyPi.
132+
- Generate the latest docs and push them to s3.

0 commit comments

Comments
 (0)