From 54240db4952a78f168e7e43e8ad0294de9f72b42 Mon Sep 17 00:00:00 2001
From: Louis Dureuil <louis@meilisearch.com>
Date: Fri, 10 Feb 2023 15:50:21 +0100
Subject: [PATCH] Add note in code so one does not forget next time

---
 meilisearch/build.rs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/meilisearch/build.rs b/meilisearch/build.rs
index cfc8cd63d..c839b6e33 100644
--- a/meilisearch/build.rs
+++ b/meilisearch/build.rs
@@ -1,6 +1,9 @@
 use vergen::{vergen, Config, SemverKind};
 
 fn main() {
+    // Note: any code that needs VERGEN_ environment variables should take care to define them manually in the Dockerfile and pass them
+    // in the corresponding GitHub workflow (publish_docker.yml).
+    // This is due to the Dockerfile building the binary outside of the git directory.
     let mut config = Config::default();
     // allow using non-annotated tags
     *config.git_mut().semver_kind_mut() = SemverKind::Lightweight;