From 3df14fc24ff7c3028c4d43aef87eae5f1824ec00 Mon Sep 17 00:00:00 2001 From: Marek Siarkowicz Date: Fri, 28 Jan 2022 16:08:28 +0100 Subject: [PATCH] Document proto annotations scripts --- scripts/update_proto_annotations.sh | 3 +++ scripts/verify_proto_annotations.sh | 2 ++ 2 files changed, 5 insertions(+) diff --git a/scripts/update_proto_annotations.sh b/scripts/update_proto_annotations.sh index 0d18304e1..75089e772 100755 --- 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 index 79f481fe5..47abbaf1d 100755 --- 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