mirror of
https://github.com/actions/checkout.git
synced 2025-11-04 15:58:09 +08:00
e6d535c99c
* Adding the ability to specify the GitHub Server URL and allowing for it to differ from the Actions workflow host * Adding tests for injecting the GitHub URL * Addressing code review comments for PR #922
92 lines
1.6 KiB
TypeScript
92 lines
1.6 KiB
TypeScript
export interface IGitSourceSettings {
|
|
/**
|
|
* The location on disk where the repository will be placed
|
|
*/
|
|
repositoryPath: string
|
|
|
|
/**
|
|
* The repository owner
|
|
*/
|
|
repositoryOwner: string
|
|
|
|
/**
|
|
* The repository name
|
|
*/
|
|
repositoryName: string
|
|
|
|
/**
|
|
* The ref to fetch
|
|
*/
|
|
ref: string
|
|
|
|
/**
|
|
* The commit to checkout
|
|
*/
|
|
commit: string
|
|
|
|
/**
|
|
* Indicates whether to clean the repository
|
|
*/
|
|
clean: boolean
|
|
|
|
/**
|
|
* The depth when fetching
|
|
*/
|
|
fetchDepth: number
|
|
|
|
/**
|
|
* Indicates whether to fetch LFS objects
|
|
*/
|
|
lfs: boolean
|
|
|
|
/**
|
|
* Indicates whether to checkout submodules
|
|
*/
|
|
submodules: boolean
|
|
|
|
/**
|
|
* Indicates whether to recursively checkout submodules
|
|
*/
|
|
nestedSubmodules: boolean
|
|
|
|
/**
|
|
* The auth token to use when fetching the repository
|
|
*/
|
|
authToken: string
|
|
|
|
/**
|
|
* The SSH key to configure
|
|
*/
|
|
sshKey: string
|
|
|
|
/**
|
|
* Additional SSH known hosts
|
|
*/
|
|
sshKnownHosts: string
|
|
|
|
/**
|
|
* Indicates whether the server must be a known host
|
|
*/
|
|
sshStrict: boolean
|
|
|
|
/**
|
|
* Indicates whether to persist the credentials on disk to enable scripting authenticated git commands
|
|
*/
|
|
persistCredentials: boolean
|
|
|
|
/**
|
|
* Organization ID for the currently running workflow (used for auth settings)
|
|
*/
|
|
workflowOrganizationId: number | undefined
|
|
|
|
/**
|
|
* Indicates whether to add repositoryPath as safe.directory in git global config
|
|
*/
|
|
setSafeDirectory: boolean
|
|
|
|
/**
|
|
* User override on the GitHub Server/Host URL that hosts the repository to be cloned
|
|
*/
|
|
githubServerUrl: string | undefined
|
|
}
|