docs: document testing var

brainboxdotcc · Oct 25, 2024 · 8ab2572 · 8ab2572
1 parent 2f551a8
commit 8ab2572
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/conanfile.py b/conanfile.py
@@ -48,6 +48,10 @@ def export(self):
         git.coordinates_to_conandata()
 
     def source(self):
+        # This environment variable should only be set by D++ library developers to ensure that conan builds succeed
+        # without having to wait for release. It will check out the development branch where conanfile.py is being 
+        # developed and tested. If you are NOT sure what this does, DO NOT SET IT. You won't get the D++ release
+        # you expect!
         if 'DPP_CONAN_TESTING' in os.environ:
             git = Git(self)
             git.clone(url="https://github.com/brainboxdotcc/DPP.git", target=".")