mirrors/rust-cache
3
0
Fork 0
mirror of https://github.com/Swatinem/rust-cache synced 2025-04-18 09:49:02 +00:00
Code Activity

Accept additional env var filters as input

Browse source
This commit is contained in:
Dominik Nakamura 2022-03-14 12:48:38 +09:00
parent c4f3eceb2f
commit db260f722e
No known key found for this signature in database
GPG key ID: E4C6A749B2491910
3 changed files with 29 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -26,6 +26,10 @@ An optional key that is added to the automatic cache key.
: `sharedKey`
An additional key that is stable over multiple jobs.
: `envVars`
A space-separated list of regular expressions that define additional environment variable filters.
These are added to an additional cache key that's generated from environment variable contents.
: `working-directory`
The working directory the action operates in, is case the cargo project is not
located in the repo root.

3
action.yml
View file

@ -8,6 +8,9 @@ inputs:
sharedKey:
description: "An additional cache key that is stable over multiple jobs"
required: false
envVars:
description: "Additional environment variables to include in the cache key, separeted by spaces"
required: false
working-directory:
description: "The working directory this action should operate in"
required: false

26
src/common.ts
View file

@ -71,7 +71,9 @@ export async function getCacheConfig(): Promise<CacheConfig> {
}
}
key += `${getEnvKey()}-`;
const extraEnvKeys = core.getInput("envVars").split(/\s+/);
key += `${getEnvKey(extraEnvKeys)}-`;
key += await getRustKey();
return {
@ -106,9 +108,22 @@ export async function getCargoBins(): Promise<Set<string>> {
}
}
function getEnvKey(): string {
/**
* Create a key hash, generated from environment variables.
*
* The available environment variables are filtered by a set of defaults that are common for Rust
* projects and should apply to almost all runs, as they modify the Rustc compiler's, Clippy's and
* other tools' behavior.
*
* @param extraKeys additional user-provided keys that are added to the default list. These are
* treated as regular expressions ({@link RegExp}), and will each be surrounded by a `^` and `$`,
* to make sure they are matched against the whole env var name.
* @returns An SHA-1 hash over all the environment variable values, whose names were not filtered
* out. The hash is returned as hex-string, **reduced to half its length**.
*/
function getEnvKey(extraKeys: string[]): string {
const hasher = crypto.createHash("sha1");
const validKeys = [
const defaultValidKeys = [
/^CARGO_.+$/,
/^CC_.+$/,
/^CXX_.+$/,
@ -120,8 +135,11 @@ function getEnvKey(): string {
/^RUSTFMT$/,
];
// Combine default key filters with user-provided ones.
const keyFilter = defaultValidKeys.concat(extraKeys.map((key) => new RegExp(`^${key}$`)));
for (const [key, value] of Object.entries(process.env)) {
if (validKeys.some((re) => re.test(key)) && value) {
if (keyFilter.some((re) => re.test(key)) && value) {
hasher.update(`${key}=${value}`);
}
}