1608130: Document how to update android-components (#667)

* 1608130: Document how to update android-components

* Update spellcheck dictionary

* Update docs/dev/cut-a-new-release.md

Co-Authored-By: Alessio Placitelli <alessio.placitelli@gmail.com>

* Update docs/dev/cut-a-new-release.md

Co-Authored-By: Alessio Placitelli <alessio.placitelli@gmail.com>

* Update docs/dev/cut-a-new-release.md

Co-Authored-By: Alessio Placitelli <alessio.placitelli@gmail.com>

* Update docs/dev/cut-a-new-release.md

Co-Authored-By: Alessio Placitelli <alessio.placitelli@gmail.com>

* Link to a-c CHANGELOG

* Change numbering format

Co-authored-by: Alessio Placitelli <alessio.placitelli@gmail.com>
This commit is contained in:
Michael Droettboom 2020-01-25 00:12:57 +05:30 коммит произвёл GitHub
Родитель 66596904db
Коммит 1d7eabea5d
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
2 изменённых файлов: 23 добавлений и 1 удалений

Просмотреть файл

@ -1,4 +1,4 @@
personal_ws-1.1 en 140 utf-8
personal_ws-1.1 en 141 utf-8
AAR
AARs
APIs
@ -89,6 +89,7 @@ gradle
grcov
hotfix
html
init
integrations
io
ios

Просмотреть файл

@ -17,6 +17,7 @@ The development & release process roughly follows the [GitFlow model](https://nv
* [Standard release](#standard-release)
* [Hotfix release for latest version](#hotfix-release-for-latest-version)
* [Hotfix release for previous version](#hotfix-release-for-previous-version)
* [Upgrading android-components to a new version of Glean](#upgrading-android-components-to-a-new-version-of-glean)
## Published artifacts
@ -204,3 +205,23 @@ If you need to release a hotfix for a previously released version (that is: not
* This is important so that no changes are lost.
* This might have merge conflicts with the `master` branch, which you need to fix before it is merged.
8. Once the above pull request lands, delete the support branch.
## Upgrading android-components to a new version of Glean
On Android, Mozilla products consume the Glean SDK through its wrapper in [`android-components`](https://github.com/mozilla-mobile/android-components).
Therefore, when a new Glean SDK release is made, `android-components` must also be updated.
After following one of the above instructions to make a Glean SDK release:
1. Ensure that CI has completed and the artifacts have published to [the Glean GitHub releases page](https://github.com/mozilla/glean/releases/).
2. Publish Glean to [Mozilla's Maven repository](https://maven.mozilla.org/).
This is currently a manual step that can only performed by individuals with the necessary credentials.
Ask in `#releaseduty-mobile` on Mozilla's internal Slack for assistance.
3. Create a pull request against `android-components` to update the Glean version with the following changes:
- The Glean version is updated in the `mozilla_glean` variable in the [`buildSrc/src/main/java/Dependencies.kt`](https://github.com/mozilla-mobile/android-components/blob/69546999739ab19d21425e9a98e107e438a3f905/buildSrc/src/main/java/Dependencies.kt#L32) file.
- The relevant parts of the Glean changelog copied into the top part of the [`android-components` changelog](https://github.com/mozilla-mobile/android-components/blob/master/docs/changelog.md).
This involves copying the Android-specific changes and the general changes to Glean, but can omit other platform-specific changes.