From e2c2f7b224e68c48ce9ee77e80d67b0295ca5ea2 Mon Sep 17 00:00:00 2001
From: ieQu1 <99872536+ieQu1@users.noreply.github.com>
Date: Fri, 1 Jul 2022 09:50:04 +0200
Subject: [PATCH] feat(bpapi): Add a header to bpapi.versions file

---
 apps/emqx/priv/bpapi.versions               | 1 +
 apps/emqx/test/emqx_bpapi_static_checks.erl | 3 +++
 2 files changed, 4 insertions(+)

diff --git a/apps/emqx/priv/bpapi.versions b/apps/emqx/priv/bpapi.versions
index 80782beca..3b49ce786 100644
--- a/apps/emqx/priv/bpapi.versions
+++ b/apps/emqx/priv/bpapi.versions
@@ -1,3 +1,4 @@
+%% This file is automatically generated by `make static_checks`, do not edit.
 {emqx,1}.
 {emqx_authn,1}.
 {emqx_authz,1}.
diff --git a/apps/emqx/test/emqx_bpapi_static_checks.erl b/apps/emqx/test/emqx_bpapi_static_checks.erl
index 63f717be5..acb941d30 100644
--- a/apps/emqx/test/emqx_bpapi_static_checks.erl
+++ b/apps/emqx/test/emqx_bpapi_static_checks.erl
@@ -300,6 +300,9 @@ dump_versions(APIs) ->
     logger:notice("Dumping API versions to ~p", [Filename]),
     ok = filelib:ensure_dir(Filename),
     {ok, FD} = file:open(Filename, [write]),
+    io:format(
+        FD, "%% This file is automatically generated by `make static_checks`, do not edit.~n", []
+    ),
     lists:foreach(
         fun(API) ->
             ok = io:format(FD, "~p.~n", [API])