Skip to content
This repository was archived by the owner on Oct 14, 2020. It is now read-only.

Commit b95492b

Browse files
committed
Minor doc tweaks + updated package-lock.json
1 parent 679d68f commit b95492b

4 files changed

Lines changed: 37 additions & 18 deletions

File tree

docs/development-on-the-utils.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -275,3 +275,8 @@ circleci build
275275
```
276276

277277
Note: Steps related to caching and uploading/storing artifacts will report as failed locally. This is not necessarily a problem, they are designed to fail since the operations are not supported locally by the CircleCI build agent.
278+
279+
# NPM release routine
280+
281+
npx publish-please --dry-run
282+
npx publish-please

package-lock.json

Lines changed: 30 additions & 11 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

webExtensionApis/study/api.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -149,16 +149,11 @@ Object of current dataPermissions (shield enabled true/false, pioneer enabled tr
149149

150150
Send Telemetry using appropriate shield or pioneer methods.
151151

152-
shield & pioneer sends using the following schema:
153-
154-
* `shield-study-addon` ping, requires object string keys and string values
152+
Note: The payload must adhere to the `data.attributes` property in the [`shield-study-addon`](https://github.com/mozilla-services/mozilla-pipeline-schemas/blob/dev/templates/include/telemetry/shieldStudyAddonPayload.3.schema.json) schema. That is, it must be a flat object with string keys and string values.
155153

156154
Note:
157155

158156
* no conversions / coercion of data happens.
159-
160-
Note:
161-
162157
* undefined what happens if validation fails
163158

164159
TBD fix the parameters here.

webExtensionApis/study/schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -656,7 +656,7 @@
656656
"name": "sendTelemetry",
657657
"type": "function",
658658
"description":
659-
"Send Telemetry using appropriate shield or pioneer methods.\n\nshield & pioneer sends using the following schema:\n- `shield-study-addon` ping, requires object string keys and string values\n\nNote:\n- no conversions / coercion of data happens.\n\nNote:\n- undefined what happens if validation fails\n\nTBD fix the parameters here.\n",
659+
"Send Telemetry using appropriate shield or pioneer methods.\n\nNote: The payload must adhere to the `data.attributes` property in the [`shield-study-addon`](https://github.com/mozilla-services/mozilla-pipeline-schemas/blob/dev/templates/include/telemetry/shieldStudyAddonPayload.3.schema.json) schema. That is, it must be a flat object with string keys and string values.\n\nNote:\n- no conversions / coercion of data happens.\n- undefined what happens if validation fails\n\nTBD fix the parameters here.\n",
660660
"async": true,
661661
"parameters": [
662662
{

0 commit comments

Comments
 (0)