Add comment explaining why the environment variable should be normalized

actions · Jun 17, 2020 · 655cb05 · 655cb05
1 parent 81bfa64
commit 655cb05
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/dist/index.js b/dist/index.js
diff --git a/src/installer.ts b/src/installer.ts
@@ -87,6 +87,10 @@ export async function getJava(
   }
 
   let extendedJavaHome = 'JAVA_HOME_' + version + '_' + arch;
+  // For portability reasons environment variables should only consist of
+  // uppercase letters, digits, and the underscore. Therefore we convert
+  // the extendedJavaHome variable to upper case and replace '.' symbols and
+  // any other non-alphanumeric characters with an underscore.
   extendedJavaHome = extendedJavaHome.toUpperCase().replace(/[^0-9A-Z_]/g, '_');
   core.exportVariable('JAVA_HOME', toolPath);
   core.exportVariable(extendedJavaHome, toolPath);