mirror of https://github.com/actions/cache.git
Reverted custom asks implemented and added wrapper
Sankalp Kotewar
2 years ago
committed by
GitHub
parent
4b5f33df54
commit
11ab7ccfa2
@ -1,86 +1,22 @@
|
|||||||
import * as cache from "@actions/cache";
|
|
||||||
import * as core from "@actions/core";
|
import * as core from "@actions/core";
|
||||||
|
|
||||||
import { Events, Inputs, State, Variables } from "./constants";
|
import { Inputs } from "./constants";
|
||||||
|
import run from "./restoreImpl";
|
||||||
import * as utils from "./utils/actionUtils";
|
import * as utils from "./utils/actionUtils";
|
||||||
|
|
||||||
async function run(): Promise<void> {
|
async function restore(): Promise<void> {
|
||||||
try {
|
const cacheKey = await run();
|
||||||
if (!utils.isCacheFeatureAvailable()) {
|
if (cacheKey) {
|
||||||
utils.setCacheHitOutput(false);
|
// Store the matched cache key in states
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Validate inputs, this can cause task failure
|
|
||||||
if (!utils.isValidEvent()) {
|
|
||||||
utils.logWarning(
|
|
||||||
`Event Validation Error: The event type ${
|
|
||||||
process.env[Events.Key]
|
|
||||||
} is not supported because it's not tied to a branch or tag ref.`
|
|
||||||
);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const primaryKey = core.getInput(Inputs.Key, { required: true });
|
|
||||||
core.saveState(State.CachePrimaryKey, primaryKey);
|
|
||||||
|
|
||||||
const restoreKeys = utils.getInputAsArray(Inputs.RestoreKeys);
|
|
||||||
const cachePaths = utils.getInputAsArray(Inputs.Path, {
|
|
||||||
required: true
|
|
||||||
});
|
|
||||||
|
|
||||||
const cacheKey = await cache.restoreCache(
|
|
||||||
cachePaths,
|
|
||||||
primaryKey,
|
|
||||||
restoreKeys
|
|
||||||
);
|
|
||||||
|
|
||||||
//Check if user wants to save cache despite of failure in any previous job
|
|
||||||
const saveCache = core.getInput(Inputs.SaveOnAnyFailure).toLowerCase();
|
|
||||||
if (saveCache == "true") {
|
|
||||||
core.debug(
|
|
||||||
`Exporting environment variable ${Variables.SaveCacheOnAnyFailure}`
|
|
||||||
);
|
|
||||||
core.exportVariable(Variables.SaveCacheOnAnyFailure, saveCache);
|
|
||||||
core.info(
|
|
||||||
`Input Variable ${Variables.SaveCacheOnAnyFailure} is set to true, the cache will be saved despite of any failure in the build.`
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!cacheKey) {
|
|
||||||
if (core.getInput(Inputs.FailOnCacheMiss).toLowerCase() == "true") {
|
|
||||||
throw new Error(
|
|
||||||
`Cache with the given input key ${primaryKey} is not found, hence exiting the workflow as the fail-on-cache-miss requirement is not met.`
|
|
||||||
);
|
|
||||||
}
|
|
||||||
core.info(
|
|
||||||
`Cache not found for input keys: ${[
|
|
||||||
primaryKey,
|
|
||||||
...restoreKeys
|
|
||||||
].join(", ")}`
|
|
||||||
);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
// Store the matched cache key
|
|
||||||
utils.setCacheState(cacheKey);
|
utils.setCacheState(cacheKey);
|
||||||
|
|
||||||
const isExactKeyMatch = utils.isExactKeyMatch(primaryKey, cacheKey);
|
const isExactKeyMatch = utils.isExactKeyMatch(
|
||||||
utils.setCacheHitOutput(isExactKeyMatch);
|
core.getInput(Inputs.Key, { required: true }),
|
||||||
|
cacheKey
|
||||||
if (
|
|
||||||
!isExactKeyMatch &&
|
|
||||||
core.getBooleanInput(Inputs.FailOnCacheMiss) == true
|
|
||||||
) {
|
|
||||||
throw new Error(
|
|
||||||
`Restored cache key doesn't match the given input key ${primaryKey}, hence exiting the workflow as the fail-on-cache-miss requirement is not met.`
|
|
||||||
);
|
);
|
||||||
}
|
utils.setCacheHitOutput(isExactKeyMatch);
|
||||||
core.info(`Cache restored from key: ${cacheKey}`);
|
core.info(`Cache restored from key: ${cacheKey}`);
|
||||||
} catch (error: unknown) {
|
|
||||||
core.setFailed((error as Error).message);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
run();
|
export default restore;
|
||||||
|
|
||||||
export default run;
|
|
||||||
|
|||||||
@ -0,0 +1,55 @@
|
|||||||
|
import * as cache from "@actions/cache";
|
||||||
|
import * as core from "@actions/core";
|
||||||
|
|
||||||
|
import { Events, Inputs, State } from "./constants";
|
||||||
|
import * as utils from "./utils/actionUtils";
|
||||||
|
|
||||||
|
async function run(): Promise<string | undefined> {
|
||||||
|
try {
|
||||||
|
if (!utils.isCacheFeatureAvailable()) {
|
||||||
|
utils.setCacheHitOutput(false);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate inputs, this can cause task failure
|
||||||
|
if (!utils.isValidEvent()) {
|
||||||
|
utils.logWarning(
|
||||||
|
`Event Validation Error: The event type ${
|
||||||
|
process.env[Events.Key]
|
||||||
|
} is not supported because it's not tied to a branch or tag ref.`
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const primaryKey = core.getInput(Inputs.Key, { required: true });
|
||||||
|
core.saveState(State.CachePrimaryKey, primaryKey);
|
||||||
|
|
||||||
|
const restoreKeys = utils.getInputAsArray(Inputs.RestoreKeys);
|
||||||
|
const cachePaths = utils.getInputAsArray(Inputs.Path, {
|
||||||
|
required: true
|
||||||
|
});
|
||||||
|
|
||||||
|
const cacheKey = await cache.restoreCache(
|
||||||
|
cachePaths,
|
||||||
|
primaryKey,
|
||||||
|
restoreKeys
|
||||||
|
);
|
||||||
|
|
||||||
|
if (!cacheKey) {
|
||||||
|
core.info(
|
||||||
|
`Cache not found for input keys: ${[
|
||||||
|
primaryKey,
|
||||||
|
...restoreKeys
|
||||||
|
].join(", ")}`
|
||||||
|
);
|
||||||
|
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
return cacheKey;
|
||||||
|
} catch (error: unknown) {
|
||||||
|
core.setFailed((error as Error).message);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default run;
|
||||||
@ -0,0 +1,17 @@
|
|||||||
|
import * as core from "@actions/core";
|
||||||
|
|
||||||
|
import { Outputs } from "./constants";
|
||||||
|
import run from "./restoreImpl";
|
||||||
|
import * as utils from "./utils/actionUtils";
|
||||||
|
|
||||||
|
async function restoreOnly(): Promise<void> {
|
||||||
|
const cacheKey = await run();
|
||||||
|
if (cacheKey) {
|
||||||
|
// Store the matched cache key in output
|
||||||
|
core.setOutput(Outputs.Key, utils.getCacheState());
|
||||||
|
|
||||||
|
core.info(`Cache restored from key: ${cacheKey}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default restoreOnly;
|
||||||
Loading…
Reference in New Issue