You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
There is no longer a need to publish changes to ably-common-go, since it
is no longer used internally, although there is a need for infra to
update the analytics pipeline, so that has been retained in the "Adding
New Agents" section.
Signed-off-by: Lewis Marshall <lewis.marshall@ably.com>
Copy file name to clipboardExpand all lines: protocol/README.md
+5-32Lines changed: 5 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,8 +76,11 @@ When a new agent is added to a client library, add a corresponding entry to [age
76
76
using the schema defined in [agents-schema.json](../json-schemas/src/agents.json), and open a pull
77
77
request against the `main` branch with those changes.
78
78
79
-
Once the pull request is merged into `main`, open an internal ticket requesting that the realtime team
80
-
follow the "Publishing Changes" steps below.
79
+
#### Analytics pipeline support
80
+
81
+
The agents are replicated in the analytics pipeline that processes agent headers. See [udtf_parse_ably_agent.py](https://github.com/ably/infrastructure/blob/main/terraform/modules/analytics/snowflake/files/functions/udtf_parse_ably_agent.py).
82
+
83
+
Once the pull request is merged into `main`, notify the Data / Infrastructure team of the changes to agents.json so that they can update the analytics data pipeine to support the newly added agents.
81
84
82
85
### Additional Notes on Agents
83
86
@@ -131,36 +134,6 @@ The following table adds more contextual detail for some agent identifiers, wher
After changes to [agents.json](agents.json) have been merged into `main`, update the generated Go code
139
-
in the [ably-common-go](https://github.com/ably/ably-common-go) repository by manually triggering the
140
-
[publish workflow](../.github/workflows/publish.yml) (see [here](https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow)
141
-
for instructions on how to do that).
142
-
143
-
There is no further, immediate downstream impact of publishing to `ably-common-go` like this.
144
-
Therefore it is safe to publish without consulting others because they have an explicit step required to update the submodule in their codebase (see [Step 2: Internal](#step-2-internal)).
145
-
146
-
#### Step 2: Internal
147
-
148
-
**Go router support**
149
-
150
-
Once the generated Go code has been updated, update the `ably-common-go` module in the
151
-
internal [go-services](https://github.com/ably/go-services) repository by running:
152
-
153
-
```bash
154
-
go get -u github.com/ably/ably-common-go
155
-
```
156
-
157
-
Open a pull request with the resulting changes to `go.mod` and `go.sum`, and once merged deploy the router
158
-
so that it's aware of the newly added agent identifiers.
159
-
160
-
**Analytics pipeline support**
161
-
162
-
The agents are replicated in the analytics pipeline that processes agent headers. See [udtf_parse_ably_agent.py](https://github.com/ably/infrastructure/blob/main/terraform/modules/analytics/snowflake/files/functions/udtf_parse_ably_agent.py). Notify the Data / Infrastructure team of the changes in `agents.json` so that support in the analytics data pipeine is added.
163
-
164
137
### `ablyLibMappings`
165
138
166
139
The `ablyLibMappings` field in [agents.json](agents.json) provides continuity for SDKs that continue to send the
0 commit comments