@@ -19,7 +19,7 @@ MAVSDK-Java is distributed through MavenCentral, meaning that it can be imported
1919```
2020dependencies {
2121 ...
22- implementation 'io.mavsdk:mavsdk:3.6.0 '
22+ implementation 'io.mavsdk:mavsdk:<version_number> '
2323 ...
2424}
2525```
@@ -29,8 +29,8 @@ For Android, `mavsdk_server` is distributed as an Android library (`aar`):
2929```
3030dependencies {
3131 ...
32- implementation 'io.mavsdk:mavsdk:3.6.0 '
33- implementation 'io.mavsdk:mavsdk-server:3.6.0 '
32+ implementation 'io.mavsdk:mavsdk:<version_number> '
33+ implementation 'io.mavsdk:mavsdk-server:<version_number> '
3434 ...
3535}
3636```
@@ -73,29 +73,17 @@ The plugins are constructed and initialized lazily upon their first call through
7373
7474### Releasing
7575
76- 1 . Update the proto submodule (./sdk/proto) to match the version of
77- ` mavsdk_server ` you want to use. The proto submodule should point to the same
78- commit hash as the proto submodule in
79- [ MAVSDK-C++] ( https://github.com/mavlink/mavsdk ) (make sure you check the hash
80- associated with the right release tag!).
81- 1 . Update the version in both modules:
82- [ ./sdk/build.gradle.kts] ( ./sdk/build.gradle.kts ) and
83- [ ./mavsdk_server/build.gradle.kts] ( ./mavsdk_server/build.gradle.kts ) . The new version
84- should be the version of ` mavsdk_server ` followed by an optional build
85- number, e.g. ` 3.6.0 ` or ` 3.6.0-2 ` . This means that the proto definitions
86- should match with the ` v3.6.0 ` tag of
87- [ MAVSDK-C++] ( https://github.com/mavlink/mavsdk ) . We support snapshots, e.g.
88- ` 3.6.0-SNAPSHOT ` will publish a temporary snapshot to Maven Central (this is
89- convenient for testing before the final release).
90- 1 . In [ ./mavsdk_server/build.gradle.kts] ( ./mavsdk_server/build.gradle.kts ) ,
91- change ` mavsdk_server_release ` to point to the version of ` mavsdk_server ` you
92- want to use. This should correspond to the proto submodule and to the version
93- numbers set in the previous step (e.g. if you set 3.6.0-2, the proto
94- submodule should point to the same hash as MAVSDK-C++ v3.6.0, and
95- ` mavsdk_server_release ` should be set to "v3.6.0").
96- 1 . Update the README to point to the new version.
97- 1 . Tag a release. The CI will publish the artifacts to Maven Central
98- automatically.
76+ When a GitHub release is created, the CI runs the release pipeline, which:
77+
78+ 1 . Extracts the package version from the release tag. The release tag is expected
79+ to be in the form "X.Y.Z-b[ -SNAPSHOT] ", where "X.Y.Z" correspond to the
80+ matching version of MAVSDK-C++ and "b" is for build numbers of MAVSDK-Java.
81+ For instance, 3.6.0, 3.6.0-2, 3.6.0-SNAPSHOT or 3.6.0-2-SNAPSHOT.
82+ 1 . Updates the ./sdk/proto submodule to point to the same commit as the
83+ corresponding proto submodule in MAVSDK-C++ (for version X.Y.Z of
84+ MAVSDK-C++).
85+ 1 . Build mavsdk and mavsdk_server and deploy them, either as SNAPSHOTs or as
86+ definitive releases.
9987
10088### Debugging without pushing to maven
10189
0 commit comments