Skip to content

Fix GitHub Actions cache on Windows when the shell is Git bash #1502

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rootkiller6788 wants to merge 1 commit into
base: main
Choose a base branch
from
+29 −5
Open

Fix GitHub Actions cache on Windows when the shell is Git bash #1502

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 29 additions & 5 deletions src/caching/github-actions-cache.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -618,10 +618,24 @@ ${blockIds.map((blockId) => ` <Uncommitted>${blockId}</Uncommitted>`).join('\n'
async #makeTarball(paths: string[], tempDir: string): Promise<string> {
// Create a manifest file so that we can pass a large number of files to
// tar.
const manifestPath = pathlib.join(tempDir, 'manifest.txt');
await fs.writeFile(manifestPath, paths.join('\n'), 'utf8');
const manifestName = 'manifest.txt';
const manifestPath = pathlib.join(tempDir, manifestName);
// The paths are absolute, and on Windows they use the native backslash
// separator. GNU tar (e.g. the one Git for Windows puts on PATH) treats a
// backslash as an escape character in its file lists, so convert to
// forward slashes. BSD tar accepts both.
await fs.writeFile(
manifestPath,
paths.map((path) => path.replaceAll('\\', '/')).join('\n'),
'utf8',
);
const tarballPath = pathlib.join(tempDir, 'cache.tgz');
await new Promise<void>((resolve, reject) => {
// Run tar from inside the temp directory and give it relative file names,
// rather than absolute ones. GNU tar on Windows interprets an absolute
// path with a drive letter (e.g. "D:\...") as a remote host, so it fails
// with "Cannot connect to D:" even though the file is local. See
// https://github.com/google/wireit/issues/1242.
execFile(
'tar',
[
Expand All @@ -636,7 +650,7 @@ ${blockIds.map((blockId) => ` <Uncommitted>${blockId}</Uncommitted>`).join('\n'
'--gzip',
'--create',
'--file',
tarballPath,
pathlib.basename(tarballPath),
// Use absolute paths (note we use the short form because the long
// form is --absolute-names on GNU tar, but --absolute-paths on BSD
// tar).
Expand All @@ -647,8 +661,9 @@ ${blockIds.map((blockId) => ` <Uncommitted>${blockId}</Uncommitted>`).join('\n'
// on disk.
'--no-recursion',
'--files-from',
manifestPath,
manifestName,
],
{cwd: tempDir},
(error: unknown) => {
if (error != null) {
reject(new Error(`tar error`, {cause: error}));
Expand Down Expand Up @@ -786,9 +801,18 @@ class GitHubActionsCacheHit implements CacheHit {

#extract(tarballPath: string): Promise<void> {
return new Promise<void>((resolve, reject) => {
// Same rationale as in #makeTarball: give tar a relative file path so a
// drive-lettered absolute path is not mistaken for a remote host.
execFile(
'tar',
['--extract', '--file', tarballPath, '--gzip', '-P'],
[
'--extract',
'--file',
pathlib.basename(tarballPath),
'--gzip',
'-P',
],
{cwd: pathlib.dirname(tarballPath)},
(error: unknown) => {
if (error != null) {
reject(new Error(`tar error`, {cause: error}));
Expand Down