actions/checkout
0
0
Fork 0
mirror of https://github.com/actions/checkout.git synced 2024-12-22 23:55:47 +02:00
Code Activity

Add workingDirectory option

Browse source 
Let user override $GITHUB_WORKSPACE as default working directory

Defaults to undefined, the original behaviour is maintained
This commit is contained in:
Marco Accorinti 2023-09-17 20:45:12 +02:00
parent 8459bc0c7e
commit 0fd0fa4fd4
4 changed files with 27 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
__test__/git-auth-helper.test.ts
View file

@ -824,7 +824,8 @@ async function setup(testName: string): Promise<void> {
sshUser: '',
workflowOrganizationId: 123456,
setSafeDirectory: true,
githubServerUrl: githubServerUrl
githubServerUrl: githubServerUrl,
workingDirectory: undefined
}
}

20
dist/index.js vendored
View file

@ -1716,14 +1716,14 @@ const workflowContextHelper = __importStar(__nccwpck_require__(9568));
function getInputs() {
return __awaiter(this, void 0, void 0, function* () {
const result = {};
// GitHub workspace
let githubWorkspacePath = process.env['GITHUB_WORKSPACE'];
if (!githubWorkspacePath) {
throw new Error('GITHUB_WORKSPACE not defined');
// Working directory
let workingDirectory = core.getInput('workingDirectory') || process.env['GITHUB_WORKSPACE'];
if (!workingDirectory) {
throw new Error('working dir not defined');
}
githubWorkspacePath = path.resolve(githubWorkspacePath);
core.debug(`GITHUB_WORKSPACE = '${githubWorkspacePath}'`);
fsHelper.directoryExistsSync(githubWorkspacePath, true);
workingDirectory = path.resolve(workingDirectory);
core.debug(`working directory = '${workingDirectory}'`);
fsHelper.directoryExistsSync(workingDirectory, true);
// Qualified repository
const qualifiedRepository = core.getInput('repository') ||
`${github.context.repo.owner}/${github.context.repo.repo}`;
@ -1738,9 +1738,9 @@ function getInputs() {
result.repositoryName = splitRepository[1];
// Repository path
result.repositoryPath = core.getInput('path') || '.';
result.repositoryPath = path.resolve(githubWorkspacePath, result.repositoryPath);
if (!(result.repositoryPath + path.sep).startsWith(githubWorkspacePath + path.sep)) {
throw new Error(`Repository path '${result.repositoryPath}' is not under '${githubWorkspacePath}'`);
result.repositoryPath = path.resolve(workingDirectory, result.repositoryPath);
if (!(result.repositoryPath + path.sep).startsWith(workingDirectory + path.sep)) {
throw new Error(`Repository path '${result.repositoryPath}' is not under '${workingDirectory}'`);
}
// Workflow repository?
const isWorkflowRepository = qualifiedRepository.toUpperCase() ===

5
src/git-source-settings.ts
View file

@ -118,4 +118,9 @@ export interface IGitSourceSettings {
* User override on the GitHub Server/Host URL that hosts the repository to be cloned
*/
githubServerUrl: string | undefined
/**
* User override of the working directory (default is $GITHUB_WORKSPACE)
*/
workingDirectory: string | undefined
}

20
src/input-helper.ts
View file

@ -8,14 +8,14 @@ import {IGitSourceSettings} from './git-source-settings'
export async function getInputs(): Promise<IGitSourceSettings> {
const result = {} as unknown as IGitSourceSettings
// GitHub workspace
let githubWorkspacePath = process.env['GITHUB_WORKSPACE']
if (!githubWorkspacePath) {
throw new Error('GITHUB_WORKSPACE not defined')
// Working directory
let workingDirectory = core.getInput('workingDirectory') || process.env['GITHUB_WORKSPACE']
if (!workingDirectory) {
throw new Error('working dir not defined')
}
githubWorkspacePath = path.resolve(githubWorkspacePath)
core.debug(`GITHUB_WORKSPACE = '${githubWorkspacePath}'`)
fsHelper.directoryExistsSync(githubWorkspacePath, true)
workingDirectory = path.resolve(workingDirectory)
core.debug(`working directory = '${workingDirectory}'`)
fsHelper.directoryExistsSync(workingDirectory, true)
// Qualified repository
const qualifiedRepository =
@ -38,16 +38,16 @@ export async function getInputs(): Promise<IGitSourceSettings> {
// Repository path
result.repositoryPath = core.getInput('path') || '.'
result.repositoryPath = path.resolve(
githubWorkspacePath,
workingDirectory,
result.repositoryPath
)
if (
!(result.repositoryPath + path.sep).startsWith(
githubWorkspacePath + path.sep
workingDirectory + path.sep
)
) {
throw new Error(
`Repository path '${result.repositoryPath}' is not under '${githubWorkspacePath}'`
`Repository path '${result.repositoryPath}' is not under '${workingDirectory}'`
)
}