Release MapLibre Android

We make MapLibre Android releases as a downloadable asset on GitHub as well as to Maven Central. Specifically we make use of a Sonatype OSSHR repository provided by Maven Central.

Also see the current release policy.

Making a release

To make an Android release, do the following:

1. Prepare a PR.

   • Update CHANGELOG.md in a PR, see for example this PR. The changelog should contain links to all relevant PRs for Android since the last release. You can use the script below with a GitHub access token with the public_repo scope. You will need to filter out PRs that do not relate to Android and categorize PRs as features or bugfixes.

     GITHUB_ACCESS_TOKEN=... node scripts/generate-changelog.mjs android
     

     The heading in the changelog must match ## <VERSION> exactly, or it will not be picked up. For example, for version 9.6.0:

     ## 9.6.0
     

   • Update android/MapLibreAndroid/gradle.properties with the new version.

2. Once the pull request updating the changelog is merged, tag the commit:

   • Create a tag locally, with for example:

     git tag -a android-v9.6.0 -m "Release android-v9.6.0"
     

   • You need write access to push the tag, use for example:

     git push --atomic origin main android-v9.6.0
     

3. Once the tag is pushed, you can run the android-release.yml workflow.

   • Open the android-release workflow page.
   • Press Run workflow and select the tag you pushed.