Skip to content
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

Respect RUNNER_TEMP environment variable #194

Closed
wants to merge 1 commit into from
Closed

Respect RUNNER_TEMP environment variable #194

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
12 changes: 11 additions & 1 deletion src/context.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,17 @@ import * as github from '@actions/github';
import {GitHub} from './github';

export class Context {
private static readonly _tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'docker-actions-toolkit-'));
private static readonly _tmpDir = fs.mkdtempSync(path.join(Context._tryCreateDirctory(process.env.RUNNER_TEMP) || os.tmpdir(), 'docker-actions-toolkit-'));

private static _tryCreateDirctory(directoryPath: string | undefined): string | undefined {
if (directoryPath !== undefined) {
const createdPath = fs.mkdirSync(directoryPath, {recursive: true});
if (createdPath !== directoryPath) {
return undefined;
}
}
return directoryPath;
}
Comment on lines +26 to +36
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't think _tryCreateDirctory is necessary, can just be:

Suggested change
private static readonly _tmpDir = fs.mkdtempSync(path.join(Context._tryCreateDirctory(process.env.RUNNER_TEMP) || os.tmpdir(), 'docker-actions-toolkit-'));
private static _tryCreateDirctory(directoryPath: string | undefined): string | undefined {
if (directoryPath !== undefined) {
const createdPath = fs.mkdirSync(directoryPath, {recursive: true});
if (createdPath !== directoryPath) {
return undefined;
}
}
return directoryPath;
}
private static readonly _tmpDir = fs.mkdtempSync(path.join(process.env.RUNNER_TEMP || os.tmpdir(), 'docker-actions-toolkit-'));

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A directory at path RUNNER_TEMP may not exist, in which case fs.mkdtempSync(path.join(process.env.RUNNER_TEMP, 'docker-actions-toolkit-')) would throw an exception. Even though the provided string is a prefix, the directory in which the temporary directory would be created must already exist.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Runner worker makes sure temp folder exists from what I see: https://github.com/actions/runner/blob/a4c57f27477077e57545af79851551ff7f5632bd/src/Runner.Worker/TempDirectoryManager.cs#L43-L44

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahh good point. This means the tests also need to point RUNNER_TEMP to an existing directory tough.
Will update the PR.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This means the tests also need to point RUNNER_TEMP to an existing directory tough.
Will update the PR.

This is already set in jest config:

actions-toolkit/jest.config.ts

Line 26 in b525cd9

RUNNER_TEMP: path.join(tmpDir, 'runner-temp'),


public static tmpDir(): string {
return Context._tmpDir;
Expand Down