Add comment

DataBiosphere · Aug 2, 2023 · a50708f · a50708f
1 parent 51e3b45
commit a50708f
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/cli/src/main/java/bio/terra/pfb/GitConfiguration.java b/cli/src/main/java/bio/terra/pfb/GitConfiguration.java
@@ -5,6 +5,9 @@
 import java.io.InputStream;
 import java.util.Properties;
 
+// Read properties from cli/build/resources/main/git.properties file
+// Enables automatically pulling library version from git.properties to use as CLI version
+// Note: Generate the git.properties file by running the generateGitProperties Gradle Command
 public class GitConfiguration {
   private static final String GIT_PROPERTIES_FILE_NAME = "git.properties";
   private static final String CLI_VERSION_BUILD_PROPERTY = "javapfb.cli.version.build";