diff --git a/docs/user/reference/yaml/index.md b/docs/user/reference/yaml/index.md index a36ca8051..05dde91c0 100644 --- a/docs/user/reference/yaml/index.md +++ b/docs/user/reference/yaml/index.md @@ -25,3 +25,8 @@ For a full reference on the `metrics.yaml` format, refer to the For a full reference on the `pings.yaml` format, refer to the [Pings YAML Registry Format](pings.md) page. + +## `tags.yaml` file + +For a full reference on the `tags.yaml` format, refer to the +[Tags YAML Registry Format](tags.md) page. diff --git a/docs/user/user/adding-glean-to-your-project/swift.md b/docs/user/user/adding-glean-to-your-project/swift.md index de7c81cdd..d080f1653 100644 --- a/docs/user/user/adding-glean-to-your-project/swift.md +++ b/docs/user/user/adding-glean-to-your-project/swift.md @@ -119,11 +119,12 @@ Follow these steps to automatically run the parser at build time: > bash $PWD/sdk_generator.sh --glean-namespace MozillaAppServices > ``` -3. Add the path to your `metrics.yaml` and (optionally) `pings.yaml` under "Input files": +3. Add the path to your `metrics.yaml` and (optionally) `pings.yaml` and `tags.yaml` under "Input files": ``` $(SRCROOT)/{project-name}/metrics.yaml $(SRCROOT)/{project-name}/pings.yaml + $(SRCROOT)/{project-name}/tags.yaml ``` 4. Add the path to the generated code file to the "Output Files": diff --git a/glean-core/ios/sdk_generator.sh b/glean-core/ios/sdk_generator.sh index 1208f6132..17e51d583 100755 --- a/glean-core/ios/sdk_generator.sh +++ b/glean-core/ios/sdk_generator.sh @@ -15,9 +15,9 @@ # # To use it in a Swift project, follow these steps: # 1. Import the `sdk_generator.sh` script into your project. -# 2. Add your `metrics.yaml` and (optionally) `pings.yaml` to your project. +# 2. Add your `metrics.yaml` and (optionally) `pings.yaml` and `tags.yaml` to your project. # 3. Add a new "Run Script" build step and set the command to `bash $PWD/sdk_generator.sh` -# 4. Add your definition files (`metrics.yaml`, `pings.yaml`) as Input Files for the "Run Script" step. +# 4. Add your definition files (`metrics.yaml`, `pings.yaml`, `tags.yaml`) as Input Files for the "Run Script" step. # 5. Run the build. # 6. Add the files in the `Generated` folder to your project. # 7. Add the same files from the `Generated` folder as Output Files of the newly created "Run SCript" step.