checkout/src/git-source-settings.ts

92 lines
1.6 KiB
TypeScript
Raw Normal View History

export interface IGitSourceSettings {
2020-03-28 01:12:15 +08:00
/**
* The location on disk where the repository will be placed
*/
repositoryPath: string
2020-03-28 01:12:15 +08:00
/**
* The repository owner
*/
repositoryOwner: string
2020-03-28 01:12:15 +08:00
/**
* The repository name
*/
repositoryName: string
2020-03-28 01:12:15 +08:00
/**
* The ref to fetch
*/
ref: string
2020-03-28 01:12:15 +08:00
/**
* The commit to checkout
*/
commit: string
2020-03-28 01:12:15 +08:00
/**
* Indicates whether to clean the repository
*/
clean: boolean
2020-03-28 01:12:15 +08:00
/**
* The depth when fetching
*/
fetchDepth: number
2020-03-28 01:12:15 +08:00
/**
* Indicates whether to fetch LFS objects
*/
lfs: boolean
2020-03-28 01:12:15 +08:00
/**
* Indicates whether to checkout submodules
*/
2020-03-06 03:21:59 +08:00
submodules: boolean
2020-03-28 01:12:15 +08:00
/**
* Indicates whether to recursively checkout submodules
*/
2020-03-06 03:21:59 +08:00
nestedSubmodules: boolean
2020-03-28 01:12:15 +08:00
/**
* The auth token to use when fetching the repository
*/
authToken: string
2020-03-28 01:12:15 +08:00
/**
* The SSH key to configure
*/
2020-03-12 03:55:17 +08:00
sshKey: string
2020-03-28 01:12:15 +08:00
/**
* Additional SSH known hosts
*/
2020-03-12 03:55:17 +08:00
sshKnownHosts: string
2020-03-28 01:12:15 +08:00
/**
* Indicates whether the server must be a known host
*/
2020-03-12 03:55:17 +08:00
sshStrict: boolean
2020-03-28 01:12:15 +08:00
/**
* Indicates whether to persist the credentials on disk to enable scripting authenticated git commands
*/
persistCredentials: boolean
2021-11-02 00:43:18 +08:00
/**
* 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
}