cache/src/utils/actionUtils.ts

96 lines
2.8 KiB
TypeScript
Raw Normal View History

import * as cache from "@actions/cache";
2019-10-30 19:48:49 +01:00
import * as core from "@actions/core";
import { Outputs, RefKey, State } from "../constants";
2019-10-30 19:48:49 +01:00
2020-09-29 16:58:32 +02:00
export function isGhes(): boolean {
const ghUrl = new URL(
process.env["GITHUB_SERVER_URL"] || "https://github.com"
);
return ghUrl.hostname.toUpperCase() !== "GITHUB.COM";
}
export function isExactKeyMatch(key: string, cacheKey?: string): boolean {
2019-10-30 19:48:49 +01:00
return !!(
cacheKey &&
cacheKey.localeCompare(key, undefined, {
2019-10-30 19:48:49 +01:00
sensitivity: "accent"
}) === 0
);
}
export function setCacheState(state: string): void {
core.saveState(State.CacheMatchedKey, state);
2019-11-12 22:48:02 +01:00
}
export function setCacheHitOutput(isCacheHit: boolean): void {
core.setOutput(Outputs.CacheHit, isCacheHit.toString());
}
export function setOutputAndState(key: string, cacheKey?: string): void {
setCacheHitOutput(isExactKeyMatch(key, cacheKey));
// Store the matched cache key if it exists
cacheKey && setCacheState(cacheKey);
2019-10-30 19:48:49 +01:00
}
export function getCacheState(): string | undefined {
const cacheKey = core.getState(State.CacheMatchedKey);
if (cacheKey) {
core.debug(`Cache state/key: ${cacheKey}`);
return cacheKey;
}
return undefined;
2019-10-30 19:48:49 +01:00
}
export function logWarning(message: string): void {
const warningPrefix = "[warning]";
core.info(`${warningPrefix}${message}`);
}
2020-04-17 21:46:46 +02:00
// Cache token authorized for all events that are tied to a ref
// See GitHub Context https://help.github.com/actions/automating-your-workflow-with-github-actions/contexts-and-expression-syntax-for-github-actions#github-context
export function isValidEvent(): boolean {
2020-04-20 19:44:37 +02:00
return RefKey in process.env && Boolean(process.env[RefKey]);
}
2020-06-02 17:21:03 +02:00
export function getInputAsArray(
name: string,
options?: core.InputOptions
): string[] {
return core
.getInput(name, options)
.split("\n")
2022-08-22 14:57:35 +02:00
.map(s => s.replace(/^\!\s+/, "!").trim())
.filter(x => x !== "")
.sort();
2020-06-02 17:21:03 +02:00
}
2020-10-02 16:59:55 +02:00
export function getInputAsInt(
name: string,
options?: core.InputOptions
): number | undefined {
const value = parseInt(core.getInput(name, options));
if (isNaN(value) || value < 0) {
2020-10-02 16:59:55 +02:00
return undefined;
}
return value;
}
export function isCacheFeatureAvailable(): boolean {
if (!cache.isFeatureAvailable()) {
if (isGhes()) {
logWarning(
"Cache action is only supported on GHES version >= 3.5. If you are on version >=3.5 Please check with GHES admin if Actions cache service is enabled or not."
);
} else {
logWarning(
"An internal error has occurred in cache backend. Please check https://www.githubstatus.com/ for any ongoing issue in actions."
);
}
return false;
}
return true;
}