From 578216950de9c1c188708369e2a31ac6c494dfee Mon Sep 17 00:00:00 2001 From: Michael Crosby Date: Tue, 30 Jul 2019 20:10:05 +0000 Subject: [PATCH] Add note about pb.txt files Closes #3163 Signed-off-by: Michael Crosby --- RELEASES.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/RELEASES.md b/RELEASES.md index 087156953..f5ec3d1ab 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -199,6 +199,10 @@ enumerating the support services and messages. See [api/](api) for details. Note that new services may be added in _minor_ releases. New service methods and new fields on messages may be added if they are optional. +`*.pb.txt` files are generated at each API release. They prevent unintentional changes +to the API by having a diff that the CI can run. These files are not intended to be +consumed or used by clients. + ### Metrics API The metrics API that outputs prometheus style metrics will be versioned independently,