Add release processes to Developer Docs (#3195)

Co-authored-by: Chris Galvan <chgalvan@amazon.com>
This commit is contained in:
Bart Louwers
2025-02-03 20:22:02 +01:00
committed by GitHub
parent a577daefd0
commit 4414e61e51
9 changed files with 184 additions and 54 deletions

View File

@@ -0,0 +1,38 @@
# Release MapLibre Android
We make MapLibre Android releases as a downloadable asset on [GitHub](https://github.com/maplibre/maplibre-native/releases?q=android&expanded=true) as well as to [Maven Central](https://central.sonatype.com/artifact/org.maplibre.gl/android-sdk/versions). Specifically we make use of a Sonatype OSSHR repository provided by Maven Central.
Also see the current [release policy](../release-policy.md).
## Making a release
To make an Android release, do the following:
1. Prepare a PR.
- Update [`CHANGELOG.md`](https://github.com/maplibre/maplibre-native/blob/main/platform/android/CHANGELOG.md) in a PR, see for example [this PR](https://github.com/maplibre/maplibre-native/pull/3194). 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](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) 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:
```md
## 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`](https://github.com/maplibre/maplibre-native/blob/main/.github/workflows/android-release.yml) workflow.
- Open the [android-release](https://github.com/maplibre/maplibre-native/actions/workflows/android-release.yml) workflow page.
- Press *Run workflow* and select the tag you pushed.