Skip to content

Commit bc842d8

Browse files
committed
Add note about generating service sources.
1 parent a4a6e9e commit bc842d8

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

DEVELOPMENT.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,28 @@ develop/test for those platforms.
3232

3333
---
3434

35+
## Updating `Sources/GeneratedServices`
36+
37+
To support CocoaPods and SwiftPM, `Sources/GeneratedServices` gets updated with
38+
the current state of the services from time to time. This is done by running:
39+
40+
```sh
41+
Tools/GenerateCheckedInServices
42+
```
43+
44+
On occasion, the service public definitions have hiccups (something in directory
45+
but the actual referenced discovery document hasn't rolled out, etc); this can
46+
be worked around by using `--skip [name]` argument(s) to tell the script to
47+
ignore something that might be bad in the directory return from discovery.
48+
49+
If a service is generating new warnings/info messages (or stops generating
50+
some), then `Tools/GenerateCheckedInServices-message_filter.json` will need to
51+
also be updated. The goal is that normal generation shouldn't produce any
52+
info/warning messages, that way it is more obvious when something might need
53+
attention.
54+
55+
---
56+
3557
## Releasing
3658

3759
To update the version number and push a release:

0 commit comments

Comments
 (0)