mirror of
https://github.com/actions/setup-python.git
synced 2026-10-31 12:41:00 +00:00
Oran Avraham
8b89ef08a0
* Use correct Poetry config when collecting Poetry projects When collecting Poetry projects for caching, a '**/poetry.lock' glob is used. However, in order to process the Poetry configuration, the "poetry" command is run from the repo's root directory; this causes Poetry to return an invalid configuration when there is a Poetry project inside an inner directory. Instead of running a single Poetry command, glob for the same pattern, and run a Poetry command for every discovered project. * Fix typo: saveSatetSpy -> saveStateSpy * poetry: Support same virtualenv appearing in multiple projects * Add nested Poetry projects test * poetry: Set up environment for each project individually * tests/cache-restore: Do not look for dependency files outside `data` When the default dependency path is used for cache distributors, they are looking for the dependency file in the project's root (including the source code), which leads to tests taking a significant amount of time, especially on Windows runners. We thus hit sporadic test failures. Change the test cases such that dependency files are always searched for inside of `__tests__/data`, ignoring the rest of the project. * poetry: Simplify `virtualenvs.in-project` boolean check * README: Explain that poetry might create multiple caches * poetry: Run `poetry env use` only after cache is loaded The virtualenv cache might contain invalid entries, such as virtualenvs built in previous, buggy versions of this action. The `poetry env use` command will recreate virtualenvs in case they are invalid, but it has to be run only *after* the cache is loaded. Refactor `CacheDistributor` a bit such that the validation (and possible recreation) of virtualenvs happens only after the cache is loaded. * poetry: Bump cache primary key
62 lines
1.7 KiB
TypeScript
62 lines
1.7 KiB
TypeScript
import * as cache from '@actions/cache';
|
|
import * as core from '@actions/core';
|
|
|
|
export enum State {
|
|
STATE_CACHE_PRIMARY_KEY = 'cache-primary-key',
|
|
CACHE_MATCHED_KEY = 'cache-matched-key',
|
|
CACHE_PATHS = 'cache-paths'
|
|
}
|
|
|
|
abstract class CacheDistributor {
|
|
protected CACHE_KEY_PREFIX = 'setup-python';
|
|
constructor(
|
|
protected packageManager: string,
|
|
protected cacheDependencyPath: string
|
|
) {}
|
|
|
|
protected abstract getCacheGlobalDirectories(): Promise<string[]>;
|
|
protected abstract computeKeys(): Promise<{
|
|
primaryKey: string;
|
|
restoreKey: string[] | undefined;
|
|
}>;
|
|
protected async handleLoadedCache() {}
|
|
|
|
public async restoreCache() {
|
|
const {primaryKey, restoreKey} = await this.computeKeys();
|
|
if (primaryKey.endsWith('-')) {
|
|
throw new Error(
|
|
`No file in ${process.cwd()} matched to [${this.cacheDependencyPath
|
|
.split('\n')
|
|
.join(',')}], make sure you have checked out the target repository`
|
|
);
|
|
}
|
|
|
|
const cachePath = await this.getCacheGlobalDirectories();
|
|
|
|
core.saveState(State.CACHE_PATHS, cachePath);
|
|
core.saveState(State.STATE_CACHE_PRIMARY_KEY, primaryKey);
|
|
|
|
const matchedKey = await cache.restoreCache(
|
|
cachePath,
|
|
primaryKey,
|
|
restoreKey
|
|
);
|
|
|
|
await this.handleLoadedCache();
|
|
|
|
this.handleMatchResult(matchedKey, primaryKey);
|
|
}
|
|
|
|
public handleMatchResult(matchedKey: string | undefined, primaryKey: string) {
|
|
if (matchedKey) {
|
|
core.saveState(State.CACHE_MATCHED_KEY, matchedKey);
|
|
core.info(`Cache restored from key: ${matchedKey}`);
|
|
} else {
|
|
core.info(`${this.packageManager} cache is not found`);
|
|
}
|
|
core.setOutput('cache-hit', matchedKey === primaryKey);
|
|
}
|
|
}
|
|
|
|
export default CacheDistributor;
|