Skip to content

Commit

Permalink
improve package cache
Browse files Browse the repository at this point in the history
  • Loading branch information
@waruqi
waruqi committed Jan 15, 2025
1 parent 1493bec commit cf24e61
Show file tree
Hide file tree
Showing 8 changed files with 280 additions and 88 deletions.
5 changes: 4 additions & 1 deletion .github/workflows/test.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,12 @@ jobs:
with:
xmake-version: ${{ matrix.version }}
actions-cache-folder: '.xmake-cache'
actions-cache-key: ${{ matrix.version }}
build-cache: true
build-cache-path: 'tests/sample/build/.build_cache'
build-cache-key: ${{ matrix.version }}
package-cache: true
package-cache-key: ${{ matrix.version }}
project-path: 'tests/sample'

- name: Run tests
run: |
Expand Down
11 changes: 11 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ with:
xmake-version: '2.9.7'
package-cache: true
package-cache-key: 'archlinux-ci'
project-path: 'myproject' # we need to compute packages hashkey for project
```
### Cache build
Expand All @@ -90,6 +91,16 @@ with:
build-cache-key: 'archlinux-ci'
```
Cache build with the specific project path.
```yml
uses: xmake-io/github-action-setup-xmake@v1
with:
xmake-version: '2.9.7'
build-cache: true
project-path: 'myproject' # we can get the build cache path from project.
```
Cache build with the specific build path.
```yml
Expand Down
3 changes: 3 additions & 0 deletions action.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ inputs:
package-cache-key:
description: The packages cache key.
default: ''
project-path:
description: The project root path.
default: ''
build-cache:
description: Enable build cache.
default: false
Expand Down
168 changes: 127 additions & 41 deletions dist/index.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82464,18 +82464,73 @@ const cache = __nccwpck_require__(6878);
const os = __nccwpck_require__(2037);
const path = __nccwpck_require__(1017);
const fsutils = __nccwpck_require__(4295);
function getBuildCacheKey() {
function getBuildTime(hours) {
let key = 'BuildTime';
if (hours && hours !== '') {
key = key + hours;
}
let buildTime = core.getState(key);
if (!buildTime || buildTime === '') {
const now = new Date();
const year = now.getFullYear();
const month = String(now.getMonth() + 1).padStart(2, '0');
const day = String(now.getDate()).padStart(2, '0');
if (!hours || hours === '') {
hours = String(now.getHours()).padStart(2, '0');
}
buildTime = `${year}${month}${day}_${hours}`;
core.saveState(key, buildTime);
}
return buildTime;
}
function getProjectRootPath() {
let projectRootPath = core.getInput('project-path');
if (!projectRootPath) {
projectRootPath = process.cwd();
}
projectRootPath = projectRootPath.trim();
if (projectRootPath && projectRootPath !== '' && !path.isAbsolute(projectRootPath)) {
projectRootPath = path.join(process.cwd(), projectRootPath);
}
return projectRootPath;
}
function getBuildCacheKey(buildCacheTime) {
var _a;
let buildCacheKey = core.getInput('build-cache-key');
if (!buildCacheKey) {
buildCacheKey = '';
}
return `xmake-build-cache-${buildCacheKey}-${os.arch()}-${os.platform()}-${(_a = process.env.RUNNER_OS) !== null && _a !== void 0 ? _a : 'unknown'}`;
if (!buildCacheTime || buildCacheTime === '') {
buildCacheTime = getBuildTime();
}
return `xmake-build-cache-${buildCacheKey}-${buildCacheTime}-${os.arch()}-${os.platform()}-${(_a = process.env.RUNNER_OS) !== null && _a !== void 0 ? _a : 'unknown'}`;
}
function getBuildCachePath() {
async function getBuildCachePath() {
let buildCachePath = core.getInput('build-cache-path');
if (!buildCachePath) {
buildCachePath = 'build/.build_cache';
buildCachePath = '';
const projectRootPath = getProjectRootPath();
if (projectRootPath && projectRootPath !== '' && fsutils.isDir(projectRootPath)) {
const options = {};
options.cwd = projectRootPath;
options.listeners = {
stdout: (data) => {
buildCachePath += data.toString();
},
};
await (0, exec_1.exec)('xmake', [
'l',
'-c',
'import("core.project.config"); import("private.cache.build_cache"); config.load(); print(build_cache.rootdir())',
], options);
buildCachePath = buildCachePath.trim();
if (buildCachePath !== '' && !path.isAbsolute(buildCachePath)) {
buildCachePath = path.join(projectRootPath, buildCachePath);
}
}
else {
buildCachePath = 'build/.build_cache';
}
}
return buildCachePath;
}
Expand All @@ -82490,21 +82545,39 @@ async function loadBuildCache() {
// export $XMAKE_ACTION_BUILD_CACHE, xmake will check it and enable build cache by default on ci.
core.exportVariable('XMAKE_ACTION_BUILD_CACHE', 'true');
const buildCacheFolder = getBuildCacheFolder();
const buildCacheKey = getBuildCacheKey();
const buildCachePath = getBuildCachePath();
const buildCachePath = await getBuildCachePath();
if (buildCacheFolder && process.env.GITHUB_WORKSPACE) {
const fullCachePath = path.join(process.env.GITHUB_WORKSPACE, buildCacheFolder);
const filepath = path.join(fullCachePath, 'build_cache_saved.txt');
if (!fsutils.isFile(filepath)) {
core.info(`Restore build cache path: ${fullCachePath} to ${buildCachePath}, key: ${buildCacheKey}`);
await cache.restoreCache([buildCacheFolder], buildCacheKey);
}
if (fsutils.isFile(filepath)) {
await io.cp(fullCachePath, buildCachePath, {
recursive: true,
});
// Since action/cache cannot overwrite updates, we try to restore the cache from the last 24 hours.
const now = new Date();
for (let i = 0; i < 24; i++) {
const hours = now.getHours() - i;
if (hours < 0) {
break;
}
const buildCacheKey = getBuildCacheKey(getBuildTime(String(hours).padStart(2, '0')));
if (!fsutils.isFile(filepath)) {
core.info(`Restore build cache path: ${fullCachePath} to ${buildCachePath}, key: ${buildCacheKey}`);
await cache.restoreCache([buildCacheFolder], buildCacheKey);
}
if (fsutils.isFile(filepath)) {
if (fsutils.isDir(buildCachePath)) {
await io.rmRF(buildCachePath);
}
await io.cp(fullCachePath, buildCachePath, {
recursive: true,
});
/* Even if the historical cache is hit, we need to update to the latest cache
* Therefore, only when the latest cache is hit, it is a real hit, and we no longer need to update the cache.
*/
if (i === 0) {
core.saveState('hitBuildCache', 'true');
}
break;
}
}
else {
if (!fsutils.isFile(filepath)) {
core.warning(`No cached files found at path "${fullCachePath}".`);
await io.rmRF(fullCachePath);
}
Expand All @@ -82518,8 +82591,9 @@ async function saveBuildCache() {
}
const buildCacheFolder = getBuildCacheFolder();
const buildCacheKey = getBuildCacheKey();
const buildCachePath = getBuildCachePath();
if (buildCacheFolder && process.env.GITHUB_WORKSPACE && fsutils.isDir(buildCachePath)) {
const buildCachePath = await getBuildCachePath();
const hitBuildCache = !!core.getState('hitBuildCache');
if (!hitBuildCache && buildCacheFolder && process.env.GITHUB_WORKSPACE && fsutils.isDir(buildCachePath)) {
const fullCachePath = path.join(process.env.GITHUB_WORKSPACE, buildCacheFolder);
core.info(`Save build cache path: ${buildCachePath} to ${fullCachePath}, key: ${buildCacheKey}`);
await io.cp(buildCachePath, fullCachePath, {
Expand Down Expand Up @@ -82706,13 +82780,38 @@ const cache = __nccwpck_require__(6878);
const os = __nccwpck_require__(2037);
const path = __nccwpck_require__(1017);
const fsutils = __nccwpck_require__(4295);
function getPackageCacheKey() {
function getProjectRootPath() {
let projectRootPath = core.getInput('project-path');
if (!projectRootPath) {
projectRootPath = process.cwd();
}
projectRootPath = projectRootPath.trim();
if (projectRootPath && projectRootPath !== '' && !path.isAbsolute(projectRootPath)) {
projectRootPath = path.join(process.cwd(), projectRootPath);
}
return projectRootPath;
}
async function getPackageCacheKey() {
var _a;
let packageCacheKey = core.getInput('package-cache-key');
if (!packageCacheKey) {
packageCacheKey = '';
}
return `xmake-package-cache-${packageCacheKey}-${os.arch()}-${os.platform()}-${(_a = process.env.RUNNER_OS) !== null && _a !== void 0 ? _a : 'unknown'}`;
let packageCacheHash = '';
const projectRootPath = getProjectRootPath();
if (projectRootPath && projectRootPath !== '' && fsutils.isDir(projectRootPath)) {
const options = {};
options.cwd = projectRootPath;
options.listeners = {
stdout: (data) => {
packageCacheHash += data.toString();
},
};
await (0, exec_1.exec)('xmake', ['repo', '--update']);
await (0, exec_1.exec)('xmake', ['l', 'utils.ci.packageskey'], options);
packageCacheHash = packageCacheHash.trim();
}
return `xmake-package-cache-${packageCacheKey}-${packageCacheHash}-${os.arch()}-${os.platform()}-${(_a = process.env.RUNNER_OS) !== null && _a !== void 0 ? _a : 'unknown'}`;
}
async function getPackageCachePath() {
let packageCachePath = '';
Expand All @@ -82724,7 +82823,6 @@ async function getPackageCachePath() {
};
await (0, exec_1.exec)('xmake', ['l', '-c', 'import("core.package.package"); print(package.installdir())'], options);
packageCachePath = packageCachePath.trim();
core.info(`packageCachePath: ${packageCachePath}`);
return packageCachePath;
}
function getPackageCacheFolder() {
Expand All @@ -82736,7 +82834,7 @@ async function loadPackageCache() {
return;
}
const packageCacheFolder = getPackageCacheFolder();
const packageCacheKey = getPackageCacheKey();
const packageCacheKey = await getPackageCacheKey();
const packageCachePath = await getPackageCachePath();
if (!packageCachePath || packageCachePath === '') {
return;
Expand All @@ -82749,9 +82847,13 @@ async function loadPackageCache() {
await cache.restoreCache([packageCacheFolder], packageCacheKey);
}
if (fsutils.isFile(filepath)) {
if (fsutils.isDir(packageCachePath)) {
await io.rmRF(packageCachePath);
}
await io.cp(fullCachePath, packageCachePath, {
recursive: true,
});
core.saveState('hitPackageCache', 'true');
}
else {
core.warning(`No cached files found at path "${fullCachePath}".`);
Expand All @@ -82766,18 +82868,18 @@ async function savePackageCache() {
return;
}
const packageCacheFolder = getPackageCacheFolder();
const packageCacheKey = getPackageCacheKey();
const packageCacheKey = await getPackageCacheKey();
const packageCachePath = await getPackageCachePath();
if (!packageCachePath || packageCachePath === '') {
return;
}
if (packageCacheFolder && process.env.GITHUB_WORKSPACE && fsutils.isDir(packageCachePath)) {
const hitPackageCache = !!core.getState('hitPackageCache');
if (!hitPackageCache && packageCacheFolder && process.env.GITHUB_WORKSPACE && fsutils.isDir(packageCachePath)) {
const fullCachePath = path.join(process.env.GITHUB_WORKSPACE, packageCacheFolder);
core.info(`Save package cache path: ${packageCachePath} to ${fullCachePath}, key: ${packageCacheKey}`);
await io.cp(packageCachePath, fullCachePath, {
recursive: true,
});
await (0, exec_1.exec)('xmake', ['l', 'os.touch', path.join(fullCachePath, 'package_cache_saved.txt')]);
await cache.saveCache([packageCacheFolder], packageCacheKey);
}
}
Expand All @@ -82792,28 +82894,12 @@ exports.savePackageCache = savePackageCache;
"use strict";

Object.defineProperty(exports, "__esModule", ({ value: true }));
exports.SshKnownHostsPath = exports.SshKeyPath = exports.PostSetSafeDirectory = exports.RepositoryPath = exports.IsPost = void 0;
exports.IsPost = void 0;
const core = __nccwpck_require__(9093);
/**
* Indicates whether the POST action is running
*/
exports.IsPost = !!core.getState('isPost');
/**
* The repository path for the POST action. The value is empty during the MAIN action.
*/
exports.RepositoryPath = core.getState('repositoryPath');
/**
* The set-safe-directory for the POST action. The value is set if input: 'safe-directory' is set during the MAIN action.
*/
exports.PostSetSafeDirectory = core.getState('setSafeDirectory') === 'true';
/**
* The SSH key path for the POST action. The value is empty during the MAIN action.
*/
exports.SshKeyPath = core.getState('sshKeyPath');
/**
* The SSH known hosts path for the POST action. The value is empty during the MAIN action.
*/
exports.SshKnownHostsPath = core.getState('sshKnownHostsPath');
// Publish a variable so that when the POST action runs, it can determine it should run the cleanup logic.
// This is necessary since we don't have a separate entry point.
if (!exports.IsPost) {
Expand Down
Loading

0 comments on commit cf24e61

Please sign in to comment.