mirror of
https://github.com/actions/cache.git
synced 2025-05-23 09:21:47 +00:00
eb78578266
* Allow for multiple line-delimited paths to cache * Add initial minimatch support * Use @actions/glob for pattern matching * Cache multiple entries using --files-from tar input remove known failing test Quote tar paths Add salt to test cache Try reading input files from manifest bump salt Run test on macos more testing Run caching tests on 3 platforms Run tests on self-hosted Apparently cant reference hosted runners by name Bump salt wait for some time after save more timing out smarter waiting Cache in tmp dir that won't be deleted Use child_process instead of actions/exec Revert tempDir hack bump salt more logging More console logging Use filepath to with cacheHttpClient Test cache restoration Revert temp dir hack debug logging clean up cache.yml testing Bump salt change debug output build actions * unit test coverage for caching multiple dirs * Ensure there's a locateable test folder at homedir * Clean up code * Version cache with all inputs * Unit test getCacheVersion * Include keys in getCacheEntry request * Clean import orders * Use fs promises in actionUtils tests * Update import order for to fix linter errors * Fix remaining linter error * Remove platform-specific test code * Add lerna example for caching multiple dirs * Lerna example updated to v2 Co-Authored-By: Josh Gross <joshmgross@github.com> Co-authored-by: Josh Gross <joshmgross@github.com>
85 lines
2.8 KiB
TypeScript
85 lines
2.8 KiB
TypeScript
import * as core from "@actions/core";
|
|
import * as path from "path";
|
|
|
|
import * as cacheHttpClient from "./cacheHttpClient";
|
|
import { CacheFilename, Events, Inputs, State } from "./constants";
|
|
import { createTar } from "./tar";
|
|
import * as utils from "./utils/actionUtils";
|
|
|
|
async function run(): Promise<void> {
|
|
try {
|
|
if (!utils.isValidEvent()) {
|
|
utils.logWarning(
|
|
`Event Validation Error: The event type ${
|
|
process.env[Events.Key]
|
|
} is not supported. Only ${utils
|
|
.getSupportedEvents()
|
|
.join(", ")} events are supported at this time.`
|
|
);
|
|
return;
|
|
}
|
|
|
|
const state = utils.getCacheState();
|
|
|
|
// Inputs are re-evaluted before the post action, so we want the original key used for restore
|
|
const primaryKey = core.getState(State.CacheKey);
|
|
if (!primaryKey) {
|
|
utils.logWarning(`Error retrieving key from state.`);
|
|
return;
|
|
}
|
|
|
|
if (utils.isExactKeyMatch(primaryKey, state)) {
|
|
core.info(
|
|
`Cache hit occurred on the primary key ${primaryKey}, not saving cache.`
|
|
);
|
|
return;
|
|
}
|
|
|
|
core.debug("Reserving Cache");
|
|
const cacheId = await cacheHttpClient.reserveCache(primaryKey);
|
|
if (cacheId == -1) {
|
|
core.info(
|
|
`Unable to reserve cache with key ${primaryKey}, another job may be creating this cache.`
|
|
);
|
|
return;
|
|
}
|
|
core.debug(`Cache ID: ${cacheId}`);
|
|
const cachePaths = await utils.resolvePaths(
|
|
core
|
|
.getInput(Inputs.Path, { required: true })
|
|
.split("\n")
|
|
.filter(x => x !== "")
|
|
);
|
|
|
|
core.debug("Cache Paths:");
|
|
core.debug(`${JSON.stringify(cachePaths)}`);
|
|
|
|
const archiveFolder = await utils.createTempDirectory();
|
|
const archivePath = path.join(archiveFolder, CacheFilename);
|
|
core.debug(`Archive Path: ${archivePath}`);
|
|
|
|
await createTar(archiveFolder, cachePaths);
|
|
|
|
const fileSizeLimit = 5 * 1024 * 1024 * 1024; // 5GB per repo limit
|
|
const archiveFileSize = utils.getArchiveFileSize(archivePath);
|
|
core.debug(`File Size: ${archiveFileSize}`);
|
|
if (archiveFileSize > fileSizeLimit) {
|
|
utils.logWarning(
|
|
`Cache size of ~${Math.round(
|
|
archiveFileSize / (1024 * 1024)
|
|
)} MB (${archiveFileSize} B) is over the 5GB limit, not saving cache.`
|
|
);
|
|
return;
|
|
}
|
|
|
|
core.debug(`Saving Cache (ID: ${cacheId})`);
|
|
await cacheHttpClient.saveCache(cacheId, archivePath);
|
|
} catch (error) {
|
|
utils.logWarning(error.message);
|
|
}
|
|
}
|
|
|
|
run();
|
|
|
|
export default run;
|