1.2.4

Absolute path for `actions-cache-folder`

.github/workflows/checkin.yml

@@ -28,6 +28,8 @@ jobs:
       - name: 'check for uncommitted changes'
         # Ensure no changes
         run: |
+          pnpm --version
+          node --version
           git add .
           if ! git diff --cached --color=always --exit-code -- . ':!node_modules'; then
             echo "::error::Found changed files after build. Please run 'pnpm release' and check in all changes."

.github/workflows/test.yml

@@ -22,16 +22,36 @@ jobs:
         with:
           xmake-version: ${{ matrix.version }}
           actions-cache-folder: '.xmake-cache'
-          actions-cache-key: ${{ matrix.version }}
+          actions-cache-key: ${{ matrix.version }}-relative
           build-cache: true
-          build-cache-key: ${{ matrix.version }}
+          build-cache-key: ${{ matrix.version }}-relative
           package-cache: true
-          package-cache-key: ${{ matrix.version }}
+          package-cache-key: ${{ matrix.version }}-relative
           project-path: 'tests/sample'
 
-      - name: Run tests
+      - name: Run tests with relative cache path
         run: |
           xmake --version
           cd tests/sample
           xmake -y -vD
           xmake run
+          xmake clean
+
+      - uses: xmake-io/github-action-setup-xmake@master
+        with:
+          xmake-version: ${{ matrix.version }}
+          actions-cache-folder: '${{ runner.temp }}/xmake-cache'
+          actions-cache-key: ${{ matrix.version }}-absolute
+          build-cache: true
+          build-cache-key: ${{ matrix.version }}-absolute
+          package-cache: true
+          package-cache-key: ${{ matrix.version }}-absolute
+          project-path: 'tests/sample'
+
+      - name: Run tests with absolute cache path
+        run: |
+          xmake --version
+          cd tests/sample
+          xmake -y -vD
+          xmake run
+          xmake clean

README.md

@@ -142,6 +142,6 @@ git branch test
 git checkout test
 pnpm build
 pnpm release
-git-commit -a -m "..."
+git commit -a -m "..."
 git push origin test
 ```

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "github-action-setup-xmake",
-  "version": "1.2.0",
+  "version": "1.2.4",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "github-action-setup-xmake",
-      "version": "1.2.0",
+      "version": "1.2.4",
       "license": "GPL-3.0-or-later",
       "dependencies": {
         "@actions/cache": "^4.0.3",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "github-action-setup-xmake",
-  "version": "1.2.0",
+  "version": "1.2.4",
   "description": "Set up your GitHub Actions workflow with a specific version of xmake",
   "main": "dist/index.js",
   "author": "OpportunityLiu",

src/build-cache.ts

@@ -2,9 +2,9 @@ import * as core from '@actions/core';
 import { exec, ExecOptions } from '@actions/exec';
 import * as io from '@actions/io';
 import * as cache from '@actions/cache';
-import * as os from 'os';
 import * as path from 'path';
 import * as fsutils from './fsutils';
+import { getPlatformIdentifier } from './system';
 
 function getBuildTime(hours?: string): string {
     let key = 'BuildTime';
@@ -38,7 +38,7 @@ function getProjectRootPath(): string {
     return projectRootPath;
 }
 
-function getBuildCacheKey(buildCacheTime?: string): string {
+async function getBuildCacheKey(buildCacheTime?: string): Promise<string> {
     let buildCacheKey = core.getInput('build-cache-key');
     if (!buildCacheKey) {
         buildCacheKey = '';
@@ -46,7 +46,8 @@ function getBuildCacheKey(buildCacheTime?: string): string {
     if (!buildCacheTime || buildCacheTime === '') {
         buildCacheTime = getBuildTime();
     }
-    return `xmake-build-cache-${buildCacheKey}-${buildCacheTime}-${os.arch()}-${os.platform()}-${process.env.RUNNER_OS ?? 'unknown'}`;
+    const platformIdentifier = await getPlatformIdentifier();
+    return `xmake-build-cache-${buildCacheKey}-${buildCacheTime}-${platformIdentifier}`;
 }
 
 async function getBuildCachePath(): Promise<string> {
@@ -112,7 +113,7 @@ export async function loadBuildCache(): Promise<void> {
             if (hours < 0) {
                 break;
             }
-            const buildCacheKey = getBuildCacheKey(getBuildTime(String(hours).padStart(2, '0')));
+            const buildCacheKey = await 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);
@@ -147,7 +148,7 @@ export async function saveBuildCache(): Promise<void> {
     }
 
     const buildCacheFolder = getBuildCacheFolder();
-    const buildCacheKey = getBuildCacheKey();
+    const buildCacheKey = await getBuildCacheKey();
     const buildCachePath = await getBuildCachePath();
 
     const hitBuildCache = !!core.getState('hitBuildCache');

src/git.ts

@@ -3,6 +3,7 @@ import * as io from '@actions/io';
 import * as os from 'os';
 import * as path from 'path';
 import { Sha, RefDic, Repo } from './interfaces';
+import { valid as isValidSemver } from 'semver';
 
 function makeOpt(ref: Sha): { cwd: string } {
     return { cwd: path.join(os.tmpdir(), `xmake-git-${ref}`) };
@@ -20,24 +21,38 @@ export async function lsRemote(repo: Repo): Promise<RefDic> {
     });
     const data: RefDic = { heads: {}, tags: {}, pull: {} };
     out.split('\n').forEach((line) => {
-        const [ref, tag] = line.trim().split('\t');
-        if (ref && tag?.startsWith('refs/')) {
-            const tagPath = tag.split('/').splice(1);
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            let ldata = data as any; // eslint-disable-line @typescript-eslint/no-unsafe-assignment
-            for (let i = 0; i < tagPath.length - 1; i++) {
-                const seg = tagPath[i];
-                // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-                if (typeof ldata[seg] === 'object') {
-                    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-                    ldata = ldata[seg]; // eslint-disable-line @typescript-eslint/no-unsafe-assignment
-                } else {
-                    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-                    ldata = ldata[seg] = {};
+        const [ref, path] = line.trim().split('\t') as [Sha, string];
+        if (ref && path?.startsWith('refs/')) {
+            const tagPath = path.split('/').splice(1);
+            switch (tagPath[0]) {
+                case 'heads': {
+                    // refs/heads/copilot/fix-6807
+                    const head = tagPath.slice(1).join('/');
+                    data.heads[head] = ref;
+                    break;
                 }
+                case 'pull': {
+                    // refs/pull/11/head
+                    // refs/pull/11/merge
+                    const pr = Number(tagPath[1]);
+                    if (!data.pull[pr]) {
+                        data.pull[pr] = {} as RefDic['pull'][number];
+                    }
+                    data.pull[pr][tagPath[2] as 'head' | 'merge'] = ref;
+                    break;
+                }
+                case 'tags': {
+                    // refs/tags/preview
+                    // refs/tags/v3.0.3
+                    const tag = tagPath.slice(1).join('/');
+                    if (isValidSemver(tag)) {
+                        data.tags[tag] = ref;
+                    }
+                    break;
+                }
+                default:
+                    break;
             }
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-            ldata[tagPath[tagPath.length - 1]] = ref;
         }
     });
     return data;

src/install.ts

@@ -7,8 +7,7 @@ import { unixInstall } from './unix-install';
 export async function installXmake(): Promise<void> {
     const version = await selectVersion();
     if (os.platform() === 'win32' || os.platform() === 'cygwin') {
-        const latest = await selectVersion('latest');
-        await winInstall(version, latest);
+        await winInstall(version);
     } else {
         await unixInstall(version);
     }

src/package-cache.ts

@@ -2,9 +2,9 @@ import * as core from '@actions/core';
 import { exec, ExecOptions } from '@actions/exec';
 import * as io from '@actions/io';
 import * as cache from '@actions/cache';
-import * as os from 'os';
 import * as path from 'path';
 import * as fsutils from './fsutils';
+import { getPlatformIdentifier } from './system';
 
 function getProjectRootPath(): string {
     let projectRootPath = core.getInput('project-path');
@@ -41,7 +41,8 @@ async function getPackageCacheKey(): Promise<string> {
         await exec('xmake', ['l', 'utils.ci.packageskey'], options);
         packageCacheHash = packageCacheHash.trim();
     }
-    return `xmake-package-cache-${packageCacheKey}-${packageCacheHash}-${os.arch()}-${os.platform()}-${process.env.RUNNER_OS ?? 'unknown'}`;
+    const platformIdentifier = await getPlatformIdentifier();
+    return `xmake-package-cache-${packageCacheKey}-${packageCacheHash}-${platformIdentifier}`;
 }
 
 async function getPackageCachePath(): Promise<string> {

src/system.ts

@@ -0,0 +1,28 @@
+import * as core from '@actions/core';
+import { exec } from '@actions/exec';
+import * as os from 'os';
+
+export async function getPlatformIdentifier(): Promise<string> {
+    let identifier = `${os.platform()}-${os.arch()}-${process.env.RUNNER_OS ?? 'unknown'}`;
+    if (os.platform() === 'darwin') {
+        let productVersion = '';
+        try {
+            await exec('sw_vers', ['-productVersion'], {
+                silent: true,
+                listeners: {
+                    stdout: (data: Buffer) => {
+                        productVersion = data.toString().trim();
+                    },
+                },
+            });
+            if (productVersion) {
+                identifier += `-${productVersion}`;
+            }
+        } catch (error: unknown) {
+            core.warning(
+                `Failed to get macOS product version: ${error instanceof Error ? error.message : String(error)}`,
+            );
+        }
+    }
+    return identifier;
+}

src/unix-install.ts

@@ -9,6 +9,7 @@ import * as path from 'path';
 import * as semver from 'semver';
 import * as git from './git';
 import { Version } from './interfaces';
+import { getPlatformIdentifier } from './system';
 
 async function install(sourceDir: string, binDir: string): Promise<void> {
     if (fs.existsSync(path.join(sourceDir, 'configure'))) {
@@ -32,12 +33,11 @@ export async function unixInstall(version: Version): Promise<void> {
     if (version.type !== 'local') {
         const ver = version.version;
         const sha = version.sha;
-        const cacheKey = `xmake-cache-${actionsCacheKey}-${ver}-${sha}-${os.arch()}-${os.platform()}-${
-            process.env.RUNNER_OS ?? 'unknown'
-        }`;
+        const platformIdentifier = await getPlatformIdentifier();
+        const cacheKey = `xmake-cache-${actionsCacheKey}-${ver}-${sha}-${platformIdentifier}`;
 
         if (actionsCacheFolder && process.env.GITHUB_WORKSPACE) {
-            const fullCachePath = path.join(process.env.GITHUB_WORKSPACE, actionsCacheFolder);
+            const fullCachePath = path.resolve(process.env.GITHUB_WORKSPACE, actionsCacheFolder);
             try {
                 try {
                     fs.accessSync(path.join(fullCachePath, 'bin', 'xmake'), fs.constants.X_OK);
@@ -48,7 +48,7 @@ export async function unixInstall(version: Version): Promise<void> {
                 toolDir = fullCachePath;
                 core.info(`cache path: ${toolDir}, key: ${cacheKey}`);
             } catch {
-                core.warning(`No cached files found at path "${fullCachePath}".`);
+                core.warning(`No cached files found at path "${fullCachePath}, key: ${cacheKey}".`);
                 await io.rmRF(fullCachePath);
             }
         } else {
@@ -65,7 +65,7 @@ export async function unixInstall(version: Version): Promise<void> {
                 let cacheDir = '';
 
                 if (actionsCacheFolder && process.env.GITHUB_WORKSPACE) {
-                    cacheDir = path.join(process.env.GITHUB_WORKSPACE, actionsCacheFolder);
+                    cacheDir = path.resolve(process.env.GITHUB_WORKSPACE, actionsCacheFolder);
                     await io.cp(binDir, cacheDir, {
                         recursive: true,
                     });

src/versions.ts

@@ -96,11 +96,11 @@ async function selectSha(repo: Repo, sha: string): Promise<Version> {
         }
     }
     return Promise.resolve(
-        new GitVersionImpl(repo, `sha#${shaValue}`, shaValue, 'sha', `commit ${shaValue.substr(0, 8)}`),
+        new GitVersionImpl(repo, `sha#${shaValue}`, shaValue, 'sha', `commit ${shaValue.substring(0, 8)}`),
     );
 }
 
-export async function selectVersion(version?: string): Promise<Version> {
+export async function selectVersion(version?: string, _fallback: boolean = false): Promise<Version> {
     // get version string
     version = (version ?? core.getInput('xmake-version')) || 'latest';
     if (version.toLowerCase() === 'latest') version = '';
@@ -123,20 +123,20 @@ export async function selectVersion(version?: string): Promise<Version> {
 
     // select branch
     if (version.startsWith('branch@')) {
-        const branch = version.substr('branch@'.length);
+        const branch = version.substring('branch@'.length);
         ret = await selectBranch(repo, branch);
     }
     // select pr
     if (version.startsWith('pr@')) {
-        const pr = Number.parseInt(version.substr('pr@'.length));
+        const pr = Number.parseInt(version.substring('pr@'.length));
         if (Number.isNaN(pr) || pr <= 0) {
-            throw new Error(`Invalid pull requrest ${version.substr('pr@'.length)}, should be a positive integer`);
+            throw new Error(`Invalid pull requrest ${version.substring('pr@'.length)}, should be a positive integer`);
         }
         ret = await selectPr(repo, pr);
     }
     // select sha
     if (version.startsWith('sha@')) {
-        const sha = version.substr('sha@'.length);
+        const sha = version.substring('sha@'.length);
         ret = await selectSha(repo, sha);
     }
     // select version
@@ -148,9 +148,9 @@ export async function selectVersion(version?: string): Promise<Version> {
     }
     if (ret.type === 'local') {
         core.info(`Use local xmake at '${ret.path}'`);
-    } else {
+    } else if (!_fallback) {
         core.info(
-            `Selected xmake ${String(ret)} (commit: ${ret.sha.substr(0, 8)})` +
+            `Selected xmake ${String(ret)} (commit: ${ret.sha.substring(0, 8)})` +
                 (repo !== DEFAULT_REPO ? ` of ${repo}` : ''),
         );
     }

src/win-install.ts

@@ -9,17 +9,22 @@ import * as path from 'path';
 import * as semver from 'semver';
 import * as git from './git';
 import { Version, GitVersion } from './interfaces';
+import { selectVersion } from './versions';
+import { getPlatformIdentifier } from './system';
 
-function getInstallerUrl(version: GitVersion, latest: GitVersion): string {
-    let ver = version.version;
+async function getInstallerUrl(version: GitVersion, _fallback: boolean = false): Promise<string> {
+    const latest = (await selectVersion('latest', _fallback)) as GitVersion;
+    const latestVers = latest.version;
+    let vers = version.version;
+    let finalUrl: string;
     switch (version.type) {
         case 'heads': {
             const arch = os.arch() === 'arm64' ? 'arm64' : os.arch() === 'x64' ? 'win64' : 'win32';
-            const latestver = latest.version;
-            if (ver !== 'dev' && ver !== 'master') {
-                ver = latestver;
+            if (vers !== 'dev' && vers !== 'master') {
+                vers = latestVers;
             }
-            return `https://github.com/xmake-io/xmake/releases/download/${latestver}/xmake-${ver}.${arch}.exe`;
+            finalUrl = `https://github.com/xmake-io/xmake/releases/download/${latestVers}/xmake-${vers}.${arch}.exe`;
+            break;
         }
         case 'pull': {
             throw new Error('PR builds for windows is not supported');
@@ -29,9 +34,10 @@ function getInstallerUrl(version: GitVersion, latest: GitVersion): string {
         }
         case 'tags': {
             const arch = os.arch() === 'arm64' ? 'arm64' : os.arch() === 'x64' ? 'win64' : 'win32';
-            return semver.gt(ver, '2.2.6')
-                ? `https://github.com/xmake-io/xmake/releases/download/${ver}/xmake-${ver}.${arch}.exe`
-                : `https://github.com/xmake-io/xmake/releases/download/${ver}/xmake-${ver}.exe`;
+            finalUrl = semver.gt(vers, '2.2.6')
+                ? `https://github.com/xmake-io/xmake/releases/download/${vers}/xmake-${vers}.${arch}.exe`
+                : `https://github.com/xmake-io/xmake/releases/download/${vers}/xmake-${vers}.exe`;
+            break;
         }
         default: {
             // check that we have tested all types
@@ -39,6 +45,21 @@ function getInstallerUrl(version: GitVersion, latest: GitVersion): string {
             throw new Error('Unknown version type');
         }
     }
+    // check if the URL returns 404. If so, xmake may have just released a
+    // new version, causing some binaries to be temporarily unavailable, so
+    // we need to fallback to the previous version.
+    if (!_fallback) {
+        const head = await fetch(finalUrl, { method: 'HEAD' });
+        if (head.status === 404) {
+            const currentVers = latestVers || vers;
+            const previousVersion = (await selectVersion('<' + currentVers)) as GitVersion;
+            core.warning(
+                `The requested version ${currentVers} (${finalUrl}) resource is temporarily unavailable, trying to fallback to the previous version...`,
+            );
+            return await getInstallerUrl(previousVersion, true);
+        }
+    }
+    return finalUrl;
 }
 
 async function installFromSource(xmakeBin: string, sourceDir: string, binDir: string): Promise<void> {
@@ -46,8 +67,8 @@ async function installFromSource(xmakeBin: string, sourceDir: string, binDir: st
     await exec(xmakeBin, ['install', '-o', binDir, 'cli'], { cwd: sourceDir });
 }
 
-export async function winInstall(version: Version, latest: Version): Promise<void> {
-    if (version.type === 'local' || latest.type === 'local') {
+export async function winInstall(version: Version): Promise<void> {
+    if (version.type === 'local') {
         throw new Error('Local builds for windows is not supported');
     }
 
@@ -59,13 +80,12 @@ export async function winInstall(version: Version, latest: Version): Promise<voi
 
     const ver = version.version;
     const sha = version.sha;
-    const cacheKey = `xmake-cache-${actionsCacheKey}-${ver}-${sha}-${os.arch()}-${os.platform()}-${
-        process.env.RUNNER_OS ?? 'unknown'
-    }`;
+    const platformIdentifier = await getPlatformIdentifier();
+    const cacheKey = `xmake-cache-${actionsCacheKey}-${ver}-${sha}-${platformIdentifier}`;
 
     let toolDir = '';
     if (actionsCacheFolder && process.env.GITHUB_WORKSPACE) {
-        const fullCachePath = path.join(process.env.GITHUB_WORKSPACE, actionsCacheFolder);
+        const fullCachePath = path.resolve(process.env.GITHUB_WORKSPACE, actionsCacheFolder);
         try {
             try {
                 fs.accessSync(path.join(fullCachePath, 'xmake.exe'), fs.constants.X_OK);
@@ -85,7 +105,7 @@ export async function winInstall(version: Version, latest: Version): Promise<voi
 
     if (!toolDir) {
         const installer = await core.group(`download xmake ${String(version)}`, async () => {
-            const url = getInstallerUrl(version, latest);
+            const url = await getInstallerUrl(version);
             core.info(`downloading from ${url}`);
             const file = await toolCache.downloadTool(url);
             const exe = path.format({
@@ -126,7 +146,7 @@ export async function winInstall(version: Version, latest: Version): Promise<voi
         if (toolDir) {
             let cacheDir = '';
             if (actionsCacheFolder && process.env.GITHUB_WORKSPACE) {
-                cacheDir = path.join(process.env.GITHUB_WORKSPACE, actionsCacheFolder);
+                cacheDir = path.resolve(process.env.GITHUB_WORKSPACE, actionsCacheFolder);
                 await io.cp(toolDir, cacheDir, {
                     recursive: true,
                 });