diff --git a/.dictionary b/.dictionary index be963c879..ac5aa9758 100644 --- a/.dictionary +++ b/.dictionary @@ -1,4 +1,4 @@ -personal_ws-1.1 en 197 utf-8 +personal_ws-1.1 en 199 utf-8 AAR AARs ABI @@ -145,6 +145,7 @@ manylinux md mdbook mdroettboom +megazord metric's mozilla mozregression diff --git a/docs/dev/cut-a-new-release.md b/docs/dev/cut-a-new-release.md index 1a3220388..3a2e249fd 100644 --- a/docs/dev/cut-a-new-release.md +++ b/docs/dev/cut-a-new-release.md @@ -94,6 +94,7 @@ When CI has finished and is green for your specific release branch, you are read * This is important so that no changes are lost. * This might have merge conflicts with the `main` branch, which you need to fix before it is merged. 8. Once the above pull request lands, delete the specific release branch. +9. Update `glean-ffi` in the iOS megazord. See the [application-services documentation for that](https://github.com/mozilla/application-services/blob/main/megazords/ios/README.md#glean-component). ## Hotfix release for latest version @@ -157,6 +158,7 @@ When CI has finished and is green for your hotfix branch, you are ready to cut a * This is important so that no changes are lost. * This might have merge conflicts with the `main` branch, which you need to fix before it is merged. 8. Once the above pull request lands, delete the hotfix branch. +9. Update `glean-ffi` in the iOS megazord. See the [application-services documentation for that](https://github.com/mozilla/application-services/blob/main/megazords/ios/README.md#glean-component). ## Hotfix release for previous version diff --git a/docs/user/adding-glean-to-your-project.md b/docs/user/adding-glean-to-your-project.md index 6e471bb18..0e17d9731 100644 --- a/docs/user/adding-glean-to-your-project.md +++ b/docs/user/adding-glean-to-your-project.md @@ -113,6 +113,27 @@ For integration with the build system you can follow the [Carthage Quick Start s ``` $(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/Glean.framework ``` + +#### Combined usage with application-services + +If your application uses both the Glean SDK and [application-services](https://github.com/mozilla/application-services) +you can use a combined release to reduce the memory usage and startup time impact. + +In your `Cartfile` require only `application-services`, e.g.: + +``` +github "mozilla/application-services" ~> "{latest-version}" +``` + +> **Important:** the `{latest-version}` placeholder should be replaced with the version number of the latest application-services release. +> You can find the version number on the [release page](https://github.com/mozilla/application-services/releases/latest). + +Then check out and build the new dependency: + +``` +carthage update --platform iOS +``` +