Document proto annotations scripts

HN0109 · Jan 28, 2022 · 3df14fc · 3df14fc
1 parent f4187b4
commit 3df14fc
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/scripts/update_proto_annotations.sh b/scripts/update_proto_annotations.sh
@@ -1,4 +1,7 @@
 #!/usr/bin/env bash
+# Updates etcd_version_annotations.txt based on state of annotations in proto files.
+# Developers can run this script to avoid manually updating etcd_version_annotations.txt.
+# Before running this script please ensure that fields/messages that you added are annotated with next etcd version.
 
 set -o errexit
 set -o nounset

diff --git a/scripts/verify_proto_annotations.sh b/scripts/verify_proto_annotations.sh
@@ -1,4 +1,6 @@
 #!/usr/bin/env bash
+# Verifies proto annotations to ensure all new proto fields and messages are annotated by comparing it with etcd_version_annotations.txt file.
+# This scripts is automatically run by CI to prevent pull requests missing adding a proto annotation.
 
 set -o errexit
 set -o nounset