Merge pull request #1285 from mozilla/document-megazord

This commit is contained in:
Jan-Erik Rediger 2020-10-28 10:09:49 +01:00 коммит произвёл GitHub
Родитель e12f0881fe 3c1b53d19f
Коммит 548b1ae9de
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
3 изменённых файлов: 33 добавлений и 3 удалений

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

@ -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

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

@ -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

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

@ -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
```
</div>
<div data-lang="Python" class="tab">
@ -229,6 +250,12 @@ Follow these steps to automatically run the parser at build time:
bash $PWD/sdk_generator.sh
```
> **Note:** If you are using the combined release of application-services and the Glean SDK you need to set the namespace to `MozillaAppServices`, e.g.:
>
> ```
> bash $PWD/sdk_generator.sh --glean-namespace MozillaAppServices
> ```
3. Add the path to your `metrics.yaml` and (optionally) `pings.yaml` under "Input files":
```