robojerk/codeql-action

Add more documentation

Browse source
This commit is contained in:
Michael B. Gale 2025-03-13 11:45:27 +00:00
parent f8367fb063
commit afa3ed33bb
No known key found for this signature in database
GPG key ID: FF5E2765BD00628F
6 changed files with 28 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

11
lib/dependency-caching.js generated
View file

@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.getJavaDependencyDir = getJavaDependencyDir;
exports.getJavaTempDependencyDir = getJavaTempDependencyDir;
exports.downloadDependencyCaches = downloadDependencyCaches;
exports.uploadDependencyCaches = uploadDependencyCaches;
const os = __importStar(require("os"));
@ -46,7 +46,12 @@ const environment_1 = require("./environment");
const util_1 = require("./util");
const CODEQL_DEPENDENCY_CACHE_PREFIX = "codeql-dependencies";
const CODEQL_DEPENDENCY_CACHE_VERSION = 1;
function getJavaDependencyDir() {
/**
* Returns a path to a directory intended to be used to store .jar files
* for the Java `build-mode: none` extractor.
* @returns The path to the directory that should be used by the `build-mode: none` extractor.
*/
function getJavaTempDependencyDir() {
return (0, path_1.join)((0, actions_util_1.getTemporaryDirectory)(), "codeql_java", "repository");
}
/**
@ -60,7 +65,7 @@ const CODEQL_DEFAULT_CACHE_CONFIG = {
// Gradle
(0, path_1.join)(os.homedir(), ".gradle", "caches"),
// CodeQL Java build-mode: none
getJavaDependencyDir(),
getJavaTempDependencyDir(),
],
hash: [
// Maven