Skip to content

Commit 5782169

Browse files
committed
Add note about pb.txt files
Closes #3163 Signed-off-by: Michael Crosby <[email protected]>
1 parent 4195136 commit 5782169

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

RELEASES.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,10 @@ enumerating the support services and messages. See [api/](api) for details.
199199
Note that new services may be added in _minor_ releases. New service methods
200200
and new fields on messages may be added if they are optional.
201201

202+
`*.pb.txt` files are generated at each API release. They prevent unintentional changes
203+
to the API by having a diff that the CI can run. These files are not intended to be
204+
consumed or used by clients.
205+
202206
### Metrics API
203207

204208
The metrics API that outputs prometheus style metrics will be versioned independently,

0 commit comments

Comments
 (0)