mirrors/rust-cache
3
0
Fork 0
mirror of https://github.com/Swatinem/rust-cache synced 2025-04-05 21:24:07 +00:00
Code Activity

feat: add option to cache all crates (#137)

Browse source 
Add cache-all-crates option which allows all crates to be cached instead
of just the dependency crates. This is useful when additional crates are
required for CI tooling.
This commit is contained in:
Steven Hartland 2023-05-11 22:15:09 +01:00 committed by GitHub
parent 827c240e23
commit def0926359
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 42 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -54,6 +54,12 @@ sensible defaults.
# default: "false" # default: "false"
cache-on-failure: "" cache-on-failure: ""
# Determines which crates are cached.
# If `true` all crates will be cached, otherwise only dependent crates will be cached.
# Useful if additional crates are used for CI tooling.
# default: "false"
cache-all-crates: ""
# Determiners whether the cache should be saved. # Determiners whether the cache should be saved.
# If `false`, the cache is only restored. # If `false`, the cache is only restored.
# Useful for jobs where the matrix is additive e.g. additional Cargo features. # Useful for jobs where the matrix is additive e.g. additional Cargo features.

4
action.yml
View file

@ -28,6 +28,10 @@ inputs:
cache-on-failure: cache-on-failure:
description: "Cache even if the build fails. Defaults to false." description: "Cache even if the build fails. Defaults to false."
required: false required: false
cache-all-crates:
description: "Determines which crates are cached. If `true` all crates will be cached, otherwise only dependent crates will be cached."
required: false
default: "false"
save-if: save-if:
description: "Determiners whether the cache should be saved. If `false`, the cache is only restored." description: "Determiners whether the cache should be saved. If `false`, the cache is only restored."
required: false required: false

6
dist/restore/index.js vendored
View file

@ -60234,7 +60234,7 @@ async function cleanBin() {
} }
} }
} }
async function cleanRegistry(packages) { async function cleanRegistry(packages, crates = true) {
// `.cargo/registry/src` // `.cargo/registry/src`
// we can remove this completely, as cargo will recreate this from `cache` // we can remove this completely, as cargo will recreate this from `cache`
await rmRF(path.join(CARGO_HOME, "registry", "src")); await rmRF(path.join(CARGO_HOME, "registry", "src"));
@ -60252,6 +60252,10 @@ async function cleanRegistry(packages) {
// TODO: else, clean `.cache` based on the `packages` // TODO: else, clean `.cache` based on the `packages`
} }
} }
if (!crates) {
core.debug(`skipping crate cleanup`);
return;
}
const pkgSet = new Set(packages.map((p) => `${p.name}-${p.version}.crate`)); const pkgSet = new Set(packages.map((p) => `${p.name}-${p.version}.crate`));
// `.cargo/registry/cache` // `.cargo/registry/cache`
const cacheDir = await fs.promises.opendir(path.join(CARGO_HOME, "registry", "cache")); const cacheDir = await fs.promises.opendir(path.join(CARGO_HOME, "registry", "cache"));

21
dist/save/index.js vendored
View file

@ -60234,7 +60234,7 @@ async function cleanBin() {
} }
} }
} }
async function cleanRegistry(packages) { async function cleanRegistry(packages, crates = true) {
// `.cargo/registry/src` // `.cargo/registry/src`
// we can remove this completely, as cargo will recreate this from `cache` // we can remove this completely, as cargo will recreate this from `cache`
await rmRF(external_path_default().join(CARGO_HOME, "registry", "src")); await rmRF(external_path_default().join(CARGO_HOME, "registry", "src"));
@ -60252,6 +60252,10 @@ async function cleanRegistry(packages) {
// TODO: else, clean `.cache` based on the `packages` // TODO: else, clean `.cache` based on the `packages`
} }
} }
if (!crates) {
core.debug(`skipping crate cleanup`);
return;
}
const pkgSet = new Set(packages.map((p) => `${p.name}-${p.version}.crate`)); const pkgSet = new Set(packages.map((p) => `${p.name}-${p.version}.crate`));
// `.cargo/registry/cache` // `.cargo/registry/cache`
const cacheDir = await external_fs_default().promises.opendir(external_path_default().join(CARGO_HOME, "registry", "cache")); const cacheDir = await external_fs_default().promises.opendir(external_path_default().join(CARGO_HOME, "registry", "cache"));
@ -60417,29 +60421,30 @@ async function run() {
await cleanTargetDir(workspace.target, packages); await cleanTargetDir(workspace.target, packages);
} }
catch (e) { catch (e) {
core.info(`[warning] ${e.stack}`); core.error(`${e.stack}`);
} }
} }
try { try {
core.info(`... Cleaning cargo registry ...`); const creates = core.getInput("cache-all-crates").toLowerCase() || "false";
await cleanRegistry(allPackages); core.info(`... Cleaning cargo registry cache-all-crates: ${creates} ...`);
await cleanRegistry(allPackages, creates === "true");
} }
catch (e) { catch (e) {
core.info(`[warning] ${e.stack}`); core.error(`${e.stack}`);
} }
try { try {
core.info(`... Cleaning cargo/bin ...`); core.info(`... Cleaning cargo/bin ...`);
await cleanBin(); await cleanBin();
} }
catch (e) { catch (e) {
core.info(`[warning] ${e.stack}`); core.error(`${e.stack}`);
} }
try { try {
core.info(`... Cleaning cargo git cache ...`); core.info(`... Cleaning cargo git cache ...`);
await cleanGit(allPackages); await cleanGit(allPackages);
} }
catch (e) { catch (e) {
core.info(`[warning] ${e.stack}`); core.error(`${e.stack}`);
} }
core.info(`... Saving cache ...`); core.info(`... Saving cache ...`);
// Pass a copy of cachePaths to avoid mutating the original array as reported by: // Pass a copy of cachePaths to avoid mutating the original array as reported by:
@ -60448,7 +60453,7 @@ async function run() {
await cache.saveCache(config.cachePaths.slice(), config.cacheKey); await cache.saveCache(config.cachePaths.slice(), config.cacheKey);
} }
catch (e) { catch (e) {
core.info(`[warning] ${e.stack}`); core.error(`${e.stack}`);
} }
} }
run(); run();

7
src/cleanup.ts
View file

@ -85,7 +85,7 @@ export async function cleanBin() {
} }
} }
export async function cleanRegistry(packages: Packages) { export async function cleanRegistry(packages: Packages, crates = true) {
// `.cargo/registry/src` // `.cargo/registry/src`
// we can remove this completely, as cargo will recreate this from `cache` // we can remove this completely, as cargo will recreate this from `cache`
await rmRF(path.join(CARGO_HOME, "registry", "src")); await rmRF(path.join(CARGO_HOME, "registry", "src"));
@ -106,6 +106,11 @@ export async function cleanRegistry(packages: Packages) {
} }
} }
if (!crates) {
core.debug(`skipping crate cleanup`);
return;
}
const pkgSet = new Set(packages.map((p) => `${p.name}-${p.version}.crate`)); const pkgSet = new Set(packages.map((p) => `${p.name}-${p.version}.crate`));
// `.cargo/registry/cache` // `.cargo/registry/cache`

15
src/save.ts
View file

@ -40,29 +40,30 @@ async function run() {
core.info(`... Cleaning ${workspace.target} ...`); core.info(`... Cleaning ${workspace.target} ...`);
await cleanTargetDir(workspace.target, packages); await cleanTargetDir(workspace.target, packages);
} catch (e) { } catch (e) {
core.info(`[warning] ${(e as any).stack}`); core.error(`${(e as any).stack}`);
} }
} }
try { try {
core.info(`... Cleaning cargo registry ...`); const creates = core.getInput("cache-all-crates").toLowerCase() || "false";
await cleanRegistry(allPackages); core.info(`... Cleaning cargo registry cache-all-crates: ${creates} ...`);
await cleanRegistry(allPackages, creates === "true");
} catch (e) { } catch (e) {
core.info(`[warning] ${(e as any).stack}`); core.error(`${(e as any).stack}`);
} }
try { try {
core.info(`... Cleaning cargo/bin ...`); core.info(`... Cleaning cargo/bin ...`);
await cleanBin(); await cleanBin();
} catch (e) { } catch (e) {
core.info(`[warning] ${(e as any).stack}`); core.error(`${(e as any).stack}`);
} }
try { try {
core.info(`... Cleaning cargo git cache ...`); core.info(`... Cleaning cargo git cache ...`);
await cleanGit(allPackages); await cleanGit(allPackages);
} catch (e) { } catch (e) {
core.info(`[warning] ${(e as any).stack}`); core.error(`${(e as any).stack}`);
} }
core.info(`... Saving cache ...`); core.info(`... Saving cache ...`);
@ -71,7 +72,7 @@ async function run() {
// TODO: remove this once the underlying bug is fixed. // TODO: remove this once the underlying bug is fixed.
await cache.saveCache(config.cachePaths.slice(), config.cacheKey); await cache.saveCache(config.cachePaths.slice(), config.cacheKey);
} catch (e) { } catch (e) {
core.info(`[warning] ${(e as any).stack}`); core.error(`${(e as any).stack}`);
} }
} }